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

Most classes are missing docstrings describing behavior #12

Open
jtgans opened this issue May 9, 2021 · 0 comments
Open

Most classes are missing docstrings describing behavior #12

jtgans opened this issue May 9, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed release blocker This blocks our next release
Milestone
1.0

Comments

@jtgans
Copy link
Owner

jtgans commented May 9, 2021

Given that over half of the g13gui module is expected to be used by third-party applications (bitwidgets, applet, observer), we should at minimum have the following things documented:

  • Every public method and object in each module should at least have a one line description of what it does, what the arguments it takes are, and what it returns
  • Unit test case methods should have a short docstring explaining what they test, and how.
@jtgans jtgans added documentation Improvements or additions to documentation help wanted Extra attention is needed good first issue Good for newcomers labels May 9, 2021
@jtgans jtgans added this to the 1.0 milestone May 9, 2021
@jtgans jtgans added the release blocker This blocks our next release label May 9, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed release blocker This blocks our next release
Projects
None yet
Milestone
1.0
Development

No branches or pull requests
1 participant
@jtgans