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

PEP 257 - docstring formatting #286

Merged
merged 5 commits into from
Jun 11, 2024
Merged

PEP 257 - docstring formatting #286

merged 5 commits into from
Jun 11, 2024

Conversation

rpreen
Copy link
Contributor

@rpreen rpreen commented Jun 11, 2024

Partially addresses #272

  • Adds pydocstyle rules in Ruff;
  • Updates all docstrings to be PEP 257 compliant;

Copy link

codecov bot commented Jun 11, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.30%. Comparing base (d22383c) to head (d094655).

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #286      +/-   ##
==========================================
+ Coverage   99.22%   99.30%   +0.07%     
==========================================
  Files          41       41              
  Lines        5303     5301       -2     
==========================================
+ Hits         5262     5264       +2     
+ Misses         41       37       -4     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@rpreen rpreen merged commit cb1ab69 into main Jun 11, 2024
5 checks passed
@rpreen rpreen deleted the pydocstyle branch June 11, 2024 09:52
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.

1 participant