-
Notifications
You must be signed in to change notification settings - Fork 18
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
Increase scope of docformatter and black [unitaryhack] #79
Conversation
Don't forget part 2 of the task @WingCode 👀 |
Codecov Report
@@ Coverage Diff @@
## main #79 +/- ##
=======================================
Coverage 96.28% 96.28%
=======================================
Files 36 36
Lines 2233 2233
=======================================
Hits 2150 2150
Misses 83 83
Continue to review full report at Codecov.
|
@soosub Regarding the part 2 of the task, The command |
Ah, I think the second task might not have been clear @WingCode. We would also like to increase the scope of the |
I'll convert the PR into a draft for now. Feel free to open it for review once it's ready! |
Just a general note that "**.py" is shell dependent and best would be to use more general expressions, thanks. |
The recursive option makes sense to me, thanks. Although, as usual, we should be careful with and test for doc files such as in |
@nariman87 Thank you for the input. If we would like to exclude some files/folders we can use We can use @soosub , @nariman87 Would like me to keep it as |
A good rule of thumb is to always listen to @nariman87 😉 Indeed, let's go with |
Yes, definitely only do --check. No particular file to exclude for now, we just need to review diffs carefully and if docformatter is applying an unintended change to some of the files, then exclude them. |
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.
Excellent work, WingCode, one approval from me.
Let's wait for @soosub's approval and possible further comments as well.
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 good to me!
Congratulations on resolving our first unitaryHACK issue, @WingCode ! I will fix some small CodeFactor issues from an earlier PR and then merge. |
Context for changes
docformatter
to all.py
files in the repository. The behavior ofdocformatter
has changed from checking and reporting incorrectly formatted docstring files to correct docstring in in-place.black
has been extended to includedoc/
as well.Example usage and tests
Performance results justifying changes
Workflow actions and tests
Expected benefits and drawbacks
Expected benefits:
Possible drawbacks:
Related Github issues
docformatter
andblack
👁️ #66Checklist and integration statements
My Python and C++ codes follow this project's coding and commenting styles as indicated by existing files. Precisely, the changes conform to given
black
,docformatter
andpylint
configurations.I have performed a self-review of these changes, checked my code (including for codefactor compliance), and corrected misspellings to the best of my capacity. I have synced this branch with others as required.
I have added context for corresponding changes in documentation and
README.md
as needed.I have added new workflow CI tests for corresponding changes, ensuring codecoverage is 95% or better, and these pass locally for me.
I have updated
CHANGELOG.md
following the template. I recognize that the developers may revisitCHANGELOG.md
and the versioning, and create a Special Release including my changes.