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 output_engine/print_mode.py #3457

Closed terriko closed 9 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 output_engine/print_mode.py

------------------------------ Detailed Coverage ------------------------------- Name Status
print_mode.py
html_print_mode (L17) 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:

Ethaaan11 commented 1 year ago

could I be assigned to this please?

aptitudepi commented 10 months ago

@Ethaaan11 Are you still working on this?

aptitudepi commented 10 months ago

@terriko PR #3675 should fix this. Not entirely sure how to link it to this issue.

aptitudepi commented 10 months ago

@terriko Does PR #3677 work better? Also, may I please be assigned to this issue?