-
Notifications
You must be signed in to change notification settings - Fork 272
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add docstring for ctapipe-train-disp-reconstructor #2420
Add docstring for ctapipe-train-disp-reconstructor #2420
Conversation
I'm trying to review this, @LukasBeiske are you available now? I have a few questions. |
It's also missing from the sphinx documentation, could you add it please? |
As far as I understand, this solves the issue, but I don't understand why the corresponding docstring has to be at the top of the file, instead of just using the one that already exist in the tool class TrainDispReconstructor. |
@ccossou I agree, the ctapipe-info tool should use the class docstring, not the module docstring |
Am I supposed to approve it now, even though we still need to change the documentation (cf comment by max)? I assume our comments about using the class docstring are more for a future pull request about a refactoring of ctapipe-info and shouldn't block this one, but that's my opinion only. |
Yes, let's do this separately. |
You need to replace some single ticks with double ticks in the docstrings: |
I noticed that the default target column of the |
Fixes #2283