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

General: Ensure you add documentation and type hints to all functions/classes. #6

Open
sgjholt opened this issue Sep 1, 2024 · 0 comments

Comments

@sgjholt
Copy link

sgjholt commented Sep 1, 2024

While this is never a hard requirement, I think that it will just make it look better and more complete to a reviewer. I also believe that if you format the documentation in a certain way, you can hook it to be automatically formatted and consumed into your static documentation.

https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html

I think it's worth the effort, if only just to make the docs look really nice.

Type hints It will also make it easier to play around with and debug for a novice user, who has some experience reading code.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant