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

Mature docstrings #20

Open
MarcSkovMadsen opened this issue Oct 9, 2022 · 0 comments
Open

Mature docstrings #20

MarcSkovMadsen opened this issue Oct 9, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@MarcSkovMadsen
Copy link
Contributor

The module, class and function docstrings should be reviewed and updated where appropriate.

Accept Criteria

  • [] Contains examples where relevant
  • [] Useful for users when used from the terminal via pn.
  • [] Useful for developers when used in IDE like VS Code.
@MarcSkovMadsen MarcSkovMadsen added documentation Improvements or additions to documentation good first issue Good for newcomers labels Oct 9, 2022
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
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@MarcSkovMadsen