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

Make sure that every public API has a nice docstring #63

Open
jeremyfowers opened this issue Dec 5, 2023 · 1 comment
Open

Make sure that every public API has a nice docstring #63

jeremyfowers opened this issue Dec 5, 2023 · 1 comment
Labels
cleanup Cleaning up old/unused code and tech debt documentation Improvements or additions to documentation p1 Medium priority

Comments

@jeremyfowers
Copy link
Collaborator

See discussion in #55

Every public API should have a docstring that explains to developers what it is for, how to use it, and what each input and output represents.
@jeremyfowers jeremyfowers added documentation Improvements or additions to documentation cleanup Cleaning up old/unused code and tech debt p1 Medium priority labels Dec 5, 2023
@jeremyfowers
Copy link
Collaborator Author

cc @danielholanda

This was referenced Dec 5, 2023
Closed
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
cleanup Cleaning up old/unused code and tech debt documentation Improvements or additions to documentation p1 Medium priority
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@jeremyfowers