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

Introduce package documentation #5

Open
IanMayo opened this issue Oct 31, 2019 · 0 comments
Open

Introduce package documentation #5

IanMayo opened this issue Oct 31, 2019 · 0 comments

Comments

@IanMayo
Copy link
Member

IanMayo commented Oct 31, 2019

This article covers Python documentation practices: https://realpython.com/documenting-python-code/

We should discuss/consider a standard to follow, and implement package/class/method level commenting in our 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