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 #8

Open
sandstromviktor opened this issue Jan 23, 2023 · 2 comments
Open

Improve documentation #8

sandstromviktor opened this issue Jan 23, 2023 · 2 comments
Labels
enhancement Improve existing features

Comments

@sandstromviktor
Copy link
Contributor

The code needs to have better documentation, i believe.
@sandstromviktor
Copy link
Contributor Author

This also includes deciding a comment convention for the code.

@sandstromviktor sandstromviktor added the enhancement Improve existing features label Jan 24, 2023
@alfredeen
Copy link
Member

For documenting modules, classes and methods we will use docstrings with format reStructuredText. See

https://peps.python.org/pep-0257/#multi-line-docstrings
https://docutils.sourceforge.io/rst.html
https://realpython.com/documenting-python-code/

@sandstromviktor sandstromviktor added feature New feature and removed feature New feature labels Jan 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement Improve existing features
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@alfredeen @sandstromviktor