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

Improve documentation #55

Open
5 of 8 tasks
klane opened this issue Jul 15, 2021 · 0 comments
Open
5 of 8 tasks

Improve documentation #55

klane opened this issue Jul 15, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed
Milestone
0.2.0

Comments

@klane
Copy link
Collaborator

klane commented Jul 15, 2021 •
edited
Loading

All classes, methods, and functions need docstrings so that Sphinx can build the documentation. Additionally, the project site needs a page for examples, the README has broken links that need fixing, and the wiki is outdated.
@klane klane added the documentation Improvements or additions to documentation label Jul 15, 2021
@klane klane added this to the Alpha release milestone Jul 15, 2021
@klane klane added the help wanted Extra attention is needed label Jul 15, 2021
@klane klane modified the milestones: Alpha release, Initial release Aug 10, 2021
@klane klane mentioned this issue Aug 12, 2021
Merged
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 help wanted Extra attention is needed
Projects
None yet
Milestone
0.2.0
Development

No branches or pull requests
1 participant
@klane