Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Add missing docstrings fetch_json_db.py #3381

Merged
merged 2 commits into from
Oct 4, 2023

Conversation

Niloth-p
Copy link
Contributor

@Niloth-p Niloth-p commented Oct 3, 2023

fixes #3380

@terriko terriko changed the title docs: Add missing docstrings docs: Add missing docstrings fetch_json_db.py Oct 3, 2023
Copy link
Contributor

@terriko terriko left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey, you've got some linter errors such as...

cve_bin_tool/fetch_json_db.py:44:6: E999 IndentationError: expected an indented block after function definition on line 35

I think mostly you need your strings indented one more level so they're in line with the code below the function definition. I put one in as an example but you can probably do the rest faster than I can through the web interface.

Comment on lines 44 to 46
"""
Initialize the Fetch_JSON_DB instance.
"""
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"""
Initialize the Fetch_JSON_DB instance.
"""
"""
Initialize the Fetch_JSON_DB instance.
"""

@terriko
Copy link
Contributor

terriko commented Oct 3, 2023

But the contents of the docstrings look good once we get the syntax fixed!

@Niloth-p
Copy link
Contributor Author

Niloth-p commented Oct 4, 2023

My bad. Thank you for pointing out the exact fix. Fixed it.

@codecov-commenter
Copy link

Codecov Report

Merging #3381 (b72e565) into main (4f4ede0) will increase coverage by 0.20%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main    #3381      +/-   ##
==========================================
+ Coverage   80.72%   80.93%   +0.20%     
==========================================
  Files         750      750              
  Lines       11534    11534              
  Branches     1560     1560              
==========================================
+ Hits         9311     9335      +24     
+ Misses       1786     1766      -20     
+ Partials      437      433       -4     
Flag Coverage Δ
longtests 75.81% <ø> (-0.02%) ⬇️
win-longtests 78.92% <ø> (+0.21%) ⬆️

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

Files Coverage Δ
cve_bin_tool/fetch_json_db.py 49.27% <ø> (ø)

... and 6 files with indirect coverage changes

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

Copy link
Contributor

@terriko terriko left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like this is ready to merge. Thank you @Niloth-p and congrats on your first commit with us. Happy hacktoberfest!

@terriko terriko merged commit e3bf661 into intel:main Oct 4, 2023
21 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs: add missing docstrings to fetch_json_db.py
3 participants