Apply docformatter in pre-commit for PEP 257 docstring auto format, no manual modifications made
#272
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bobleesj
commented
Dec 23, 2024
| @@ -80,7 +79,8 @@ def wsinterp(x, xp, fp, left=None, right=None): | |||
|
|
|||
|
|
|||
| def nsinterp(xp, fp, qmin=0, qmax=25, left=None, right=None): | |||
| """One-dimensional Whittaker-Shannon interpolation onto the Nyquist-Shannon grid. | |||
| """One-dimensional Whittaker-Shannon interpolation onto the Nyquist-Shannon | |||
There was a problem hiding this comment.
nice - it automatically makes the first line within a certain line length.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #272 +/- ##
=======================================
Coverage 98.68% 98.68%
=======================================
Files 8 8
Lines 379 379
=======================================
Hits 374 374
Misses 5 5
|
bobleesj
commented
Dec 23, 2024
| @@ -10,7 +9,7 @@ | |||
|
|
|||
|
|
|||
| def test_loadData_default(datafile): | |||
| """check loadData() with default options""" | |||
| """Check loadData() with default options.""" | |||
There was a problem hiding this comment.
Nice - automatic start with cap letter
|
@sbillinge I think it's super useful.. I could add this to our cookiecutting standard if you find it useful too. |
bobleesj
changed the title
docformatter in pre-commit, no manual modifications madedocformatter in pre-commit for PEP 257 docstring auto format, no manual modifications made
Yes, will wait for the user config docstrings to be merged first. |
bobleesj
changed the title
docformatter in pre-commit for PEP 257 docstring auto format, no manual modifications madedocformatter in pre-commit for PEP 257 docstring auto format, no manual modifications made
|
@sbillinge ready for review - resolved the conflict |
bobleesj
changed the title
docformatter in pre-commit for PEP 257 docstring auto format, no manual modifications madedocformatter in pre-commit for PEP 257 docstring auto format, no manual modifications made
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Just ran
pre-commitonly - I think it's quite useful