-
Notifications
You must be signed in to change notification settings - Fork 443
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 data_sources/curl_source.py #3464
Labels
documentation
Documentation changes
good first issue
Good for newcomers
hacktoberfest
good issue for hacktoberfest participation
Comments
terriko
added
good first issue
Good for newcomers
documentation
Documentation changes
hacktoberfest
good issue for hacktoberfest participation
labels
Oct 25, 2023
I’ll be working on this. |
I want to work on it assign me! |
@AryanBakliwal spoke first, so I've assigned them this issue! |
Oh, wait, I've realized that @AryanBakliwal also claimed #3463 . In the interest of sharing out more easy issues, I'm going to leave #3563 assigned to @AryanBakliwal but let @shivam200446 take this one. |
closed by #3489 |
terriko
added a commit
to terriko/cve-bin-tool
that referenced
this issue
Nov 16, 2023
intel#3489) * Update curl_source.py * chore: blacken cve_bin_tool/data_sources/curl_source.py --------- Co-authored-by: Terri Oda <terri.oda@intel.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
documentation
Documentation changes
good first issue
Good for newcomers
hacktoberfest
good issue for hacktoberfest participation
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 f
output_engine/pdfbuilder.py
.interrogate
(a tool for checking docstrings) says it's missing the following docstrings:interrogate -vv -i -I -M -C data_sources/curl_source.py
------------------------------ 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: