-
Notifications
You must be signed in to change notification settings - Fork 482
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
docs: add missing docstrings to async_utils.py #3385
Comments
Hi could I work on this issue? |
@Kaito117 I've assigned it to you! Let us know if you get stuck. This particular file is missing more docstrings than most! |
Please assign me this issue? |
@SuryaCreatX I'm still working on the issue. |
@Kaito117 Hello ! Are you still working on the issue ? |
@NabhiA |
Closed with #3442 |
We haven't been entirely consistent about adding python docstrings to every function, and I'd like to start improving the codebase. I'm filing separate tickets for each file I want updated so hacktoberfest folk can claim them more easily -- please only claim one or two at a time.
Here's a tutorial on docstrings in case you're not sure what they are. Basically I want someone to write a short sentence explaining what a function does and have it put at the top of the function in the way that python expects docstrings to look. (You can also do classes and methods.)
This issue is for updating the file fetch_json_db.py.
interrogate
(a tool for checking docstrings) says it's missing the following docstrings:------------------------------ Detailed Coverage -------------------------------
You will need to actually read the file and figure out what it does, then describe each function. Feel free to ask questions if you're not sure, or submit a partial fix where you only add docstrings to some functions.
Short tips for new contributors:
Claiming issues:
The text was updated successfully, but these errors were encountered: