docs: add missing docstrings to log.py #3383

[NabhiA]

fixes #3383
docstrings added to the file as mentioned in the issue

[NabhiA]

please let me know if something needs to be changed

[codecov-commenter]

Codecov Report

Merging #3388 (83e17e3) into main (2847879) will increase coverage by 5.21%.
Report is 1 commits behind head on main.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main    #3388      +/-   ##
==========================================
+ Coverage   75.83%   81.05%   +5.21%     
==========================================
  Files         750      750              
  Lines       11534    11534              
  Branches     1560     1560              
==========================================
+ Hits         8747     9349     +602     
+ Misses       2435     1759     -676     
- Partials      352      426      +74     

Flag	Coverage Δ
longtests	75.81% <ø> (-0.02%)	⬇️
win-longtests	79.04% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

Files	Coverage Δ
cve_bin_tool/log.py	76.92% <ø> (ø)

... and 23 files with indirect coverage changes

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

[NabhiA]

I am unable to understand the error thrown in this pr. It will be really helpful if I can get some assistance @terriko

[terriko]

Looks like some of the linters are failing. You can read about our linters, what they're for and how to run them here:
https://github.com/intel/cve-bin-tool/blob/main/CONTRIBUTING.md#running-linters

At a glance, the issue is likely some whitespace blank lines that black and isort want added/removed.

If you don't already have them installed, run
pip install black isort
to install them.

Then you'll need to run each of those tools on the file, and they should automatically reformat to their standards:

isort log.py
black log.py

Then add/commit the updated file to your PR and you should pass the tests on the next run!

[NabhiA]

I have ran both the commands on the file. Please check if this works or if its okay I can raise a new PR for it

[NabhiA]

I have addressed all the issues. Please check if it works well

[terriko]

Looks good now, thank you! Congratulations on your first merged commit with us and happy hacktoberfest!

[NabhiA]

Thank you for guiding me through! Please let me know if there are more such good first issues open which I can address, I will be glad to contribute again