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

Finish documentation with @doc #3

Open
3 tasks
vreuter opened this issue Mar 18, 2024 · 0 comments
Open
3 tasks

Finish documentation with @doc #3

vreuter opened this issue Mar 18, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@vreuter
Copy link
Contributor

vreuter commented Mar 18, 2024 •
edited
Loading

Use numpydoc_decorator to finish the documentation.

  • check that everything's importable and has expected docstring
  • use even with classes
  • may need to add support for documenting @classmethod members in this way (e.g., for build and from_json_file on the DoG transformation)
@vreuter vreuter self-assigned this Mar 18, 2024
@vreuter vreuter added the documentation Improvements or additions to documentation label Mar 18, 2024
@vreuter vreuter removed their assignment Mar 18, 2024
@vreuter vreuter added the good first issue Good for newcomers label Mar 18, 2024
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
@vreuter