Skip to content
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

Improve Coreg docstrings #434

Open
rhugonnet opened this issue Sep 6, 2023 · 0 comments · May be fixed by #502
Open

Improve Coreg docstrings #434

rhugonnet opened this issue Sep 6, 2023 · 0 comments · May be fixed by #502
Labels
documentation Improvements or additions to documentation

Comments

@rhugonnet
Copy link
Contributor

Maybe to-do after things have changed in the next weeks.

          Maybe a minor comment. Should we expand the docstrings at the beginning of each coreg submodule to better explain what it contains?

E.g in base.py: """Base coregistration classes to define generic methods and pre/post-processing of input data.""" -> add a short description of the base Coreg class and attributes, the Pipeline and the Blockwise? Or is it too redundant with the doc and or the specific docstrings?

Originally posted by @adehecq in #424 (comment)

@rhugonnet rhugonnet added the documentation Improvements or additions to documentation label Jan 31, 2024
@rhugonnet rhugonnet linked a pull request May 5, 2024 that will close this issue
14 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant