-
Notifications
You must be signed in to change notification settings - Fork 482
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
Conversation
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.
This looks decent. I'm going to try to merge the fix for the flake8 error and re-run the tests.
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 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 Report
@@ 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
Flags with carried forward coverage won't be shown. Click here to find out more.
... and 29 files with indirect coverage changes 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
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.
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!
Thank you @terriko, I will make the required changes asap. |
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. |
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 that did the trick, and we're ready to merge. Thank you and happy hacktoberfest!
fixes intel#3463 --------- Co-authored-by: Terri Oda <terri@toybox.ca>
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