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

Add meaningful docstrings #18

Open
KingNook opened this issue Sep 16, 2024 · 0 comments
Open

Add meaningful docstrings #18

KingNook opened this issue Sep 16, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation ongoing Something that will probably be reopened / permanently open due to its nature

Comments

@KingNook
Copy link
Owner

Context

(See comment in #12) Not necessarily high priority but the project is starting to get a little large and I will inevitably begin to forget what, why or how functions work. To prevent this / alleviate the symptoms, I wanna give each function / method a meaningful docstring

Thoughts / Challenges

There's probably a PEP somewhere with relevant information so I'll try to follow that guideline once I find it. If not I'll figure out my own standard.

@KingNook KingNook added documentation Improvements or additions to documentation ongoing Something that will probably be reopened / permanently open due to its nature labels Sep 16, 2024
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 ongoing Something that will probably be reopened / permanently open due to its nature
Projects
None yet
Development

No branches or pull requests

1 participant