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

Add pydocstyle to pre-commit for consistent docstrings #1028

Closed
wants to merge 4 commits into from

Conversation

pauladkisson
Copy link
Member

@pauladkisson pauladkisson commented Aug 23, 2024

Fixes #284 pt 1

@CodyCBakerPhD
Copy link
Member

It might be easiest, if @h-mayorquin is OK with pydocstyle, to take it one DXYZ at a time (by ignoring/selecting in the pyproject.toml)

@h-mayorquin
Copy link
Collaborator

Yes, let's open a PR for each of those items.

Concerning this PR, it is time for me to take a look into that hook.

@pauladkisson
Copy link
Member Author

Sorry, but what do you mean one DXYZ at a time?

@pauladkisson pauladkisson changed the title added pydocstyle to pre-commit Add pydocstyle to pre-commit for consistent docstrings Aug 26, 2024
@CodyCBakerPhD
Copy link
Member

D102, D103, D401, etc.

@pauladkisson
Copy link
Member Author

Actually, bc of the way DXYZs are selected via convention=numpy, and with tools like docformatter, I think it will be easiest to just do this all at once.

Copy link

codecov bot commented Aug 30, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.67%. Comparing base (727228c) to head (feb9001).
Report is 15 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #1028   +/-   ##
=======================================
  Coverage   90.67%   90.67%           
=======================================
  Files         129      129           
  Lines        7879     7879           
=======================================
  Hits         7144     7144           
  Misses        735      735           
Flag Coverage Δ
unittests 90.67% <100.00%> (ø)

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

Files with missing lines Coverage Δ
src/neuroconv/baseextractorinterface.py 100.00% <ø> (ø)
src/neuroconv/nwbconverter.py 94.77% <ø> (ø)
src/neuroconv/utils/checks.py 100.00% <ø> (ø)
src/neuroconv/utils/dict.py 93.97% <ø> (ø)
src/neuroconv/utils/json_schema.py 96.79% <100.00%> (ø)
src/neuroconv/utils/path.py 100.00% <ø> (ø)
src/neuroconv/utils/str_utils.py 100.00% <ø> (ø)

Sign up for free to 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.

[Testing]: check docstrings for consistency
3 participants