Skip to content

Conversation

btwshivam
Copy link
Contributor

Added missing docstrings to data_sources/curl_source.py
I have explained what a function does and have it put at the top of the function in the way that Python expects docstrings to look.
Issue no #3464

@btwshivam
Copy link
Contributor Author

@terriko mam I have added docstring please look at it once

Copy link
Contributor Author

@btwshivam btwshivam left a comment

Choose a reason for hiding this comment

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

fixed

@codecov-commenter
Copy link

codecov-commenter commented Oct 30, 2023

Codecov Report

Merging #3489 (011d36b) into main (0861a9a) will decrease coverage by 0.34%.
Report is 1 commits behind head on main.
The diff coverage is n/a.

❗ Current head 011d36b differs from pull request most recent head 4058791. Consider uploading reports for the commit 4058791 to get more accurate results

@@            Coverage Diff             @@
##             main    #3489      +/-   ##
==========================================
- Coverage   78.45%   78.12%   -0.34%     
==========================================
  Files         758      758              
  Lines       11483    11483              
  Branches     1341     1341              
==========================================
- Hits         9009     8971      -38     
- Misses       2037     2093      +56     
+ Partials      437      419      -18     
Flag Coverage Δ
win-longtests 78.12% <ø> (-0.34%) ⬇️

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

Files Coverage Δ
cve_bin_tool/data_sources/curl_source.py 98.00% <ø> (ø)

... and 4 files with indirect coverage changes

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

self.vulnerability_data = []

async def get_cve_data(self):
"""Get cURL vulnerability data. Fetches the cURL vulnerability data and retrieves a list of affected data.
Copy link
Contributor

Choose a reason for hiding this comment

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

looks like you've got some linter errors, likely related to this line not having a """ at the end of it

Suggested change
"""Get cURL vulnerability data. Fetches the cURL vulnerability data and retrieves a list of affected data.
"""Get cURL vulnerability data. Fetches the cURL vulnerability data and retrieves a list of affected data."""

Copy link
Contributor Author

Choose a reason for hiding this comment

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

oh, I'm sorry, I fixed that!

Copy link
Contributor Author

@btwshivam btwshivam left a comment

Choose a reason for hiding this comment

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

fixed

@btwshivam btwshivam requested a review from terriko October 30, 2023 20:40
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.

Still failing black tests so I can't merge this, but it looks pretty close to ready so I'll mark it as hacktoberfest-approved now in case you need the credit.

@terriko terriko added awaiting submitter Need more information from submitter HACKTOBERFEST-ACCEPTED and removed awaiting CI labels Nov 1, 2023
@terriko
Copy link
Contributor

terriko commented Nov 2, 2023

This had the same issue as the other one: black wanted a blank line after the class docstring. I've added one and am re-running the linters.

@terriko terriko added awaiting maintainer Need a maintainer to respond / help out and removed awaiting submitter Need more information from submitter labels Nov 2, 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.

Looks like we're all set now. Thanks again and happy hacktoberfest!

@terriko terriko merged commit 44b5e99 into intel:main Nov 2, 2023
terriko added a commit to terriko/cve-bin-tool that referenced this pull request Nov 16, 2023
intel#3489)

* Update curl_source.py
* chore: blacken cve_bin_tool/data_sources/curl_source.py

---------

Co-authored-by: Terri Oda <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
awaiting maintainer Need a maintainer to respond / help out HACKTOBERFEST-ACCEPTED
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants