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.

Sign up for GitHub

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

Jump to bottom

Populate All Functions with Docstrings #6

Open
ethan-r-hansen opened this issue Oct 21, 2024 · 0 comments
Open

Populate All Functions with Docstrings #6

ethan-r-hansen opened this issue Oct 21, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@ethan-r-hansen
Copy link
Contributor

We should populate all functions with docstrings, especially those that are frequently used across the code. This will allow users to hover over the function in their IDE, see all inputs to the function and the brief description. We can also auto-generate documentation if we pick a standard docstring format. Something to discuss in a future meeting.
@ethan-r-hansen ethan-r-hansen added the documentation Improvements or additions to documentation label Oct 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@ethan-r-hansen