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

Functions Missing Typehints and Docstrings #67

Closed
parisosuch-dev opened this issue Aug 26, 2024 · 1 comment
Closed

Functions Missing Typehints and Docstrings #67

parisosuch-dev opened this issue Aug 26, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@parisosuch-dev
Copy link
Member

Good amount of functions missing docstrings. Missing type hints for parameters and return values as well.
Doc strings should be created using Google python docstring style guidelines. There is a great VS Code extension that does this for you: autoDocstring - Python Docstring Generator
@parisosuch-dev parisosuch-dev added the documentation Improvements or additions to documentation label Aug 26, 2024
@brennanfreeze
Copy link
Member

Closing as this is being addressed in many other issues.

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
4 participants
@parisosuch-dev @brennanfreeze and others