-
Notifications
You must be signed in to change notification settings - Fork 9
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
Improved module/package docstrings #226
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks a lot! I updated the PR a bit already to remove some linting errors. I really like the new docstrings, more descriptive, without being too verbose! I have added some small comments/suggestions, but nothing major.
Co-authored-by: qubixes <[email protected]>
I have applied the changes! I will also create an issue to update the frontpage of the docs to reflect the content of the metasyn |
bf765b2
to
cdd7e89
Compare
cdd7e89
to
7edfc13
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good now!
This is a first step towards improving the docstrings. Proper docstrings will help the automatically generated API be more usable and informative, it will also help using the package itself.
Next step will be class and function docstrings. But for now, module level docstrings.
I have tried to keep them under 79 characters per line, but in some cases an exception had to be made.