-
Notifications
You must be signed in to change notification settings - Fork 41
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.
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
[HELP NEEDED] Add docstring to every function in tirith #90
Labels
Comments
refeed
added
need-discussion
The requirements isn't clear yet, need more thorough discussion
and removed
need-discussion
The requirements isn't clear yet, need more thorough discussion
labels
Jul 31, 2024
Hi @refeed Please assign me this issue. |
Everybody can just work on this task without being assigned and send PR directly because this is a very big task :) |
refeed
changed the title
🚀 Add docstring to every function in tirith
[HELP NEEDED] Add docstring to every function in tirith
Sep 17, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
Anyone are welcome to contribute to solve this issue!
But there are rules to this:
Related to #90
to your commit description and PR.<name of the file>.py: Add docstring
for the title of your PR and commitIs your feature request related to a problem? Please describe.
Most functions in this project don't have docstring yet
E.g
Describe the solution you'd like
I'd like to see the functions in this project to have docstring
e.g.
Describe alternatives you've considered
There are many functions and modules in this project. Hence, this is a very big task, anyone can take this issue. Any PR that does this would be appreciated.
For the next step, we can also put pydocstyle linter in github workflow for a more standardized docstring style https://github.com/PyCQA/pydocstyle
The text was updated successfully, but these errors were encountered: