intel / cve-bin-tool

The CVE Binary Tool helps you determine if your system includes known vulnerabilities. You can scan binaries for over 200 common, vulnerable components (openssl, libpng, libxml2, expat and others), or if you know the components used, you can get a list of known vulnerabilities associated with an SBOM or a list of components and versions.
https://cve-bin-tool.readthedocs.io/en/latest/
GNU General Public License v3.0
1.21k stars 460 forks source link

docs: add missing docstrings to data_sources/curl_source.py #3464

Closed terriko closed 12 months ago

terriko commented 1 year ago

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 foutput_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 ------------------------------- Name Status
curl_source.py
Curl_Source (L25) MISSED
Curl_Source.get_cve_data (L42) MISSED
Curl_Source.fetch_cves (L48) MISSED
Curl_Source.download_curl_vulnerabilities (L59) MISSED
Curl_Source.get_cve_list (L68) MISSED
------------------------------------------------------------- ----------------

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:

AryanBakliwal commented 1 year ago

I’ll be working on this.

btwshivam commented 1 year ago

I want to work on it assign me!

terriko commented 1 year ago

@AryanBakliwal spoke first, so I've assigned them this issue!

terriko commented 1 year ago

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.

terriko commented 12 months ago

closed by #3489