Skip to content

Apply docformatter in pre-commit for PEP 257 docstring auto format, no manual modifications made - #272

Merged
sbillinge merged 5 commits into
diffpy:mainfrom
bobleesj:docformatter
Dec 26, 2024
Merged

Apply docformatter in pre-commit for PEP 257 docstring auto format, no manual modifications made#272
sbillinge merged 5 commits into
diffpy:mainfrom
bobleesj:docformatter

Conversation

@bobleesj

Copy link
Copy Markdown
Contributor

Just ran pre-commit only - I think it's quite useful


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

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice - it automatically makes the first line within a certain line length.

@codecov

codecovBot commented Dec 23, 2024

Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.68%. Comparing base (de55560) to head (32c0018).
Report is 6 commits behind head on main.

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 
Files with missing linesCoverage Δ
tests/test_loaddata.py100.00% <ø> (ø)
tests/test_version.py100.00% <ø> (ø)


def test_loadData_default(datafile):
"""check loadData() with default options"""
"""Check loadData() with default options."""

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice - automatic start with cap letter

@bobleesj

Copy link
Copy Markdown
ContributorAuthor

@sbillinge I think it's super useful.. I could add this to our cookiecutting standard if you find it useful too.

@bobleesjbobleesj changed the title Apply docformatter in pre-commit, no manual modifications madeApply docformatter in pre-commit for PEP 257 docstring auto format, no manual modifications madeDec 23, 2024
@sbillinge

Copy link
Copy Markdown
Contributor

@bobleesj this is conflicted now. I think it would be a good idea to wait until #267 is merged (I think that is the right one, the config creator) and then merge main into this and run it again. Otherwise this will make that one conflicted.

@bobleesj

Copy link
Copy Markdown
ContributorAuthor

@bobleesj this is conflicted now.

Yes, will wait for the user config docstrings to be merged first.

@bobleesjbobleesj changed the title Apply docformatter in pre-commit for PEP 257 docstring auto format, no manual modifications made(Re-visit after user-config docstring merged) Apply docformatter in pre-commit for PEP 257 docstring auto format, no manual modifications madeDec 25, 2024
@bobleesj

Copy link
Copy Markdown
ContributorAuthor

@sbillinge ready for review - resolved the conflict

@bobleesjbobleesj changed the title (Re-visit after user-config docstring merged) Apply docformatter in pre-commit for PEP 257 docstring auto format, no manual modifications madeApply docformatter in pre-commit for PEP 257 docstring auto format, no manual modifications madeDec 25, 2024
@sbillinge
sbillinge merged commit 969ca54 into diffpy:mainDec 26, 2024
@bobleesj
bobleesj deleted the docformatter branch December 26, 2024 13:36
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@bobleesj@sbillinge