docs: add missing docstrings to data_sources/gad_source.py #3466

[btwshivam]

Updated the docstrings of two missing Functions
GAD_Source (L25).
GAD_Source.parse_multiple_version (L176)
Issue No - #3466

[btwshivam]

@terriko Sorry for the inconvenience! The previous PR was creating a lot of conflicts so I created a new PR with new commit. please look at it.

[btwshivam]

fixed request change

[terriko]

Looks like the black linter is failing. if you run black it should fix the file for you, then you'll need to add the fixed file to the PR.

[btwshivam]

Looks like the black linter is failing. if you run black it should fix the file for you, then you'll need to add the fixed file to the PR.

Looks like the black linter is failing. if you run black it should fix the file for you, then you'll need to add the fixed file to the PR.

Looks like the black linter is failing. if you run black it should fix the file for you, then you'll need to add the fixed file to the PR.

how can I fix it?

[terriko]

As I said, you'll need to run black on the file to fix it. I'll write it out for you:

If you don't have black installed, start with

pip install black

Then run it on the file

black data_sources/gad_source.py

It will automatically change the file for you, so don't forget to check the file back in and push it to your pr:

git add data_sources/gad_source.py
git commit
git push

[terriko]

And if you want to read up on linters, there's more about what they are and how we use them in https://github.com/intel/cve-bin-tool/blob/main/CONTRIBUTING.md#running-linters (I highly recommend pre-commit to help you in the future!)

[terriko]

I can't merge this because it's still failing the black checks, but it's close enough to ready that I'll mark it as hacktoberfest approved so you can get the credit (I'm heading to bed soon so I won't be around for just-under-the-wire finishes!)

[terriko]

I've run black locally and made the changes it recommended (an extra blank line) so the tests will re-run now.

[codecov-commenter]

Codecov Report

Merging #3488 (a0cbfcc) into main (0c1d8ce) will increase coverage by 0.82%.
Report is 12 commits behind head on main.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main    #3488      +/-   ##
==========================================
+ Coverage   77.94%   78.77%   +0.82%     
==========================================
  Files         758      758              
  Lines       11483    11484       +1     
  Branches     1341     1342       +1     
==========================================
+ Hits         8950     9046      +96     
+ Misses       2110     2029      -81     
+ Partials      423      409      -14     

Flag	Coverage Δ
win-longtests	78.77% <ø> (+0.82%)	⬆️

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

Files	Coverage Δ
cve_bin_tool/data_sources/gad_source.py	74.22% <ø> (ø)

... and 8 files with indirect coverage changes

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

[terriko]

All tests passing, time to merge. Thank you and happy hacktoberfest!