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

DOC: README.md further maintenance #22

Open
4 tasks
cpelley opened this issue May 2, 2024 · 0 comments
Open
4 tasks

DOC: README.md further maintenance #22

cpelley opened this issue May 2, 2024 · 0 comments
Assignees
@cpelley
Labels
documentation Improvements or additions to documentation

Comments

@cpelley
Copy link
Collaborator

cpelley commented May 2, 2024 •
edited
Loading

Tasks

  • Migrate some of the documentation from README.md to relevant Python modules (module documentation).
  • Fluff out missing class/function/method/module docstrings.
  • Ensure all docstrings are rendered correctly as markdown.
  • Update call signature extract to accommodate non type defaults.

Issues
@cpelley cpelley added the documentation Improvements or additions to documentation label May 2, 2024
@cpelley cpelley self-assigned this May 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@cpelley cpelley

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@cpelley