docs: increase docstring coverage to 100%

[hai1337]

Added missing docstrings to acheive 100% coverage 🎉

Signed-off-by: Thomas, Hailee [email protected]
Signed-off-by: Patel, Narendra [email protected]>
Signed-off-by: Menchaca, Jesus [email protected]

fixes: #4900

[terriko]

These are looking great. Can you run black to fixing the linting issues so we can merge these? (it usually fixes flake8 too) It looks like it's only complaining about 2 files:

• cve_bin_tool/available_fix/redhat_cve_tracker.py
• cve_bin_tool/error_handler.py

[hai1337]

Hey @terriko, we were just about to open a PR for adding a docstring style guide to CONTRIBUTING.md and enforce a style in interrogate, but there are some conflicts with the Google style, e.g. it requires init to be documented but interrogate is set up to ignore that. Doing more research, Sphinx/reStructuredText style could be a better fit, especially since Sphinx is already used within the project and can generate some really nice code documentation. It might be worth creating a new issue to investigate this further. In the meantime, we will add some generic text in CONTRIBUTING.md for docstrings in another PR, and more work on defining and enforcing a style can be done later.

Since this PR used google style docstrings, I'll leave it up to you whether we want it merged or not, I do think the content is valuable either way.

[terriko]

Let's merge this as is and file an issue, since it's not like our docstrings are entirely consistent yet anyhow. Thank you so much for working on this!