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

Code should be fully documented #11

Open
3 tasks
chrisk314 opened this issue Jan 31, 2018 · 0 comments
Open
3 tasks

Code should be fully documented #11

chrisk314 opened this issue Jan 31, 2018 · 0 comments
Assignees
Labels
enhancement New feature or request P low
Milestone

Comments

@chrisk314
Copy link
Owner

chrisk314 commented Jan 31, 2018

All code must be fully documented with docstrings adhering to best practices. The following must be completed:

  • All modules have a docstring
  • All classes and functions have docstrings
  • Inline comments are present where code might be complex/confusing
@chrisk314 chrisk314 added enhancement New feature or request P low labels Jan 31, 2018
@chrisk314 chrisk314 added this to the v0.4 milestone Jan 31, 2018
@chrisk314 chrisk314 self-assigned this Jan 31, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request P low
Projects
None yet
Development

No branches or pull requests

1 participant