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

Missing code documentation #17

Open
JiriPavela opened this issue Feb 6, 2023 · 0 comments
Open

Missing code documentation #17

JiriPavela opened this issue Feb 6, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@JiriPavela
Copy link
Collaborator

The codebase should contain some form of documentation. Ideally, I'd suggest writing module and function docstrings and ideally also provide a way to generate HTML / PDF / Markdown documentation using tools like Sphinx.
@JiriPavela JiriPavela added the documentation Improvements or additions to documentation label Feb 6, 2023
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
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@JiriPavela