-
Notifications
You must be signed in to change notification settings - Fork 567
docs: add missing docstrings to data_sources/curl_source.py #3464 #3489
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
Conversation
@terriko mam I have added docstring please look at it once |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fixed
Codecov Report
@@ 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
Flags with carried forward coverage won't be shown. Click here to find out more.
... 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. |
There was a problem hiding this comment.
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
"""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.""" |
There was a problem hiding this comment.
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!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fixed
There was a problem hiding this 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.
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. |
There was a problem hiding this 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!
intel#3489) * Update curl_source.py * chore: blacken cve_bin_tool/data_sources/curl_source.py --------- Co-authored-by: Terri Oda <[email protected]>
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