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

Multi-line docstrings #38

Open
MGNute opened this issue Jul 14, 2023 · 0 comments
Open

Multi-line docstrings #38

MGNute opened this issue Jul 14, 2023 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@MGNute
Copy link
Collaborator

MGNute commented Jul 14, 2023

Most or maybe all of the functions have only single-line docstrings currently and lack a longer description of what the function does and how it operates (per PEP 257), and I personally find those to be very helpful for development. Unless there's a specific reason why those have been excluded, I'd like to create a branch specifically for proper multi-line docstrings with the second, more elaborate section. Open to discussion about guidelines for that though.

@MGNute MGNute added the documentation Improvements or additions to documentation label Jul 14, 2023
@MGNute MGNute self-assigned this Jul 14, 2023
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

No branches or pull requests

1 participant