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 to output_engine/init.py #3480

Merged
merged 4 commits into from
Nov 2, 2023

Conversation

AryanBakliwal
Copy link
Contributor

docs:add missing docstrings to output_engine/init.py

Added missing docstrings for methods and classes mentioned in issue #3463
Referred PEP 257 – Docstring Conventions

fixes #3463

@terriko terriko changed the title docs:add missing docstrings docs: add missing docstrings to output_engine/init.py Oct 30, 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.

This looks decent. I'm going to try to merge the fix for the flake8 error and re-run the tests.

cve_bin_tool/output_engine/__init__.py Outdated Show resolved Hide resolved
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 black still has some recommendations for you. can you run black on the file to auto-fix it and then commit the changes to this PR?

@codecov-commenter
Copy link

codecov-commenter commented Oct 30, 2023

Codecov Report

Merging #3480 (64129d5) into main (4bde7e8) will decrease coverage by 1.61%.
Report is 19 commits behind head on main.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main    #3480      +/-   ##
==========================================
- Coverage   80.34%   78.74%   -1.61%     
==========================================
  Files         758      758              
  Lines       11615    11484     -131     
  Branches     1571     1342     -229     
==========================================
- Hits         9332     9043     -289     
- Misses       1867     2031     +164     
+ Partials      416      410       -6     
Flag Coverage Δ
longtests ?
win-longtests 78.74% <ø> (+0.75%) ⬆️

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

Files Coverage Δ
cve_bin_tool/output_engine/__init__.py 62.46% <ø> (-0.29%) ⬇️

... and 29 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.

I can't merge this because it's not passing the black tests, but it's close enough that I'll mark it as hacktoberfest accepted so you get credit. Please fix the black issues if you can so we can actually merge it!

@terriko terriko added awaiting response Need more information from submitter HACKTOBERFEST-ACCEPTED labels Nov 1, 2023
@AryanBakliwal
Copy link
Contributor Author

Thank you @terriko, I will make the required changes asap.

@terriko
Copy link
Contributor

terriko commented Nov 2, 2023

I ran black on a local copy and it suggested one extra blank line, so I'm adding that manually here and re-running the linters.

@terriko terriko added awaiting maintainer Need a maintainer to respond / help out and removed awaiting CI 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 that did the trick, and we're ready to merge. Thank you and happy hacktoberfest!

@terriko terriko merged commit e61f367 into intel:main Nov 2, 2023
21 checks passed
terriko added a commit to terriko/cve-bin-tool that referenced this pull request Nov 16, 2023
fixes  intel#3463

---------

Co-authored-by: Terri Oda <terri@toybox.ca>
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 awaiting response Need more information from submitter HACKTOBERFEST-ACCEPTED
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs:add missing docstrings to output_engine/__init__.py
3 participants