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

Code documentation #3

Closed
eriknovak opened this issue May 21, 2024 · 0 comments · Fixed by #18
Closed

Code documentation #3

eriknovak opened this issue May 21, 2024 · 0 comments · Fixed by #18
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@eriknovak
Copy link
Owner

eriknovak commented May 21, 2024 •
edited
Loading

Describe the missing documentation

The current code is mostly undocumented. It would be good to have all components documented, showing the input parameters and what they return. Furthermore, using typings would help with IntelliSense, i.e. autocompletion of the code.

Possible doc style: https://peps.python.org/pep-0257/

Example of use: https://www.programiz.com/python-programming/docstrings
@eriknovak eriknovak added documentation Improvements or additions to documentation help wanted Extra attention is needed good first issue Good for newcomers labels May 21, 2024
@eriknovak eriknovak assigned eriknovak and unassigned eriknovak May 21, 2024
This was referenced Jun 16, 2024
Closed
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 good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add code documentation eriknovak/anonipy
1 participant
@eriknovak