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

Docstring linting cleanup #321

Merged
merged 8 commits into from
Feb 9, 2024
Merged

Docstring linting cleanup #321

merged 8 commits into from
Feb 9, 2024

Conversation

Zeitsperre
Copy link
Collaborator

@Zeitsperre Zeitsperre commented Feb 8, 2024

Pull Request Checklist:

  • This PR addresses an already opened issue (for bug fixes / features)
    • This PR fixes issue #xyz
  • Tests for the changes have been added (for bug fixes / features)
  • Documentation has been added / updated (for bug fixes / features)
  • HISTORY.rst has been updated (with summary of main changes)
  • I have added my relevant user information to AUTHORS.md

What kind of change does this PR introduce?:

  • Updates pre-commit hooks, pins linting tools to their pre-commit equivalents
  • Adds a configuration for codespell
  • Fixes a few docstrings, specifies some class methods as static methods
  • Renames a few internal variables for clarity, rephrased a few sentences for grammar/spelling

Does this PR introduce a breaking change?:

No.

Other information:

https://github.com/codespell-project/codespell

@Zeitsperre Zeitsperre added the documentation Improvements or additions to documentation label Feb 8, 2024
@Zeitsperre Zeitsperre self-assigned this Feb 8, 2024
@coveralls
Copy link

coveralls commented Feb 8, 2024

Pull Request Test Coverage Report for Build 7846047808

  • -3 of 32 (90.63%) changed or added relevant lines in 3 files are covered.
  • 1 unchanged line in 1 file lost coverage.
  • Overall coverage increased (+0.03%) to 72.656%

Changes Missing Coverage Covered Lines Changed/Added Lines %
clisops/ops/base_operation.py 15 18 83.33%
Files with Coverage Reduction New Missed Lines %
clisops/ops/average.py 1 81.25%
Totals Coverage Status
Change from base Build 7844594970: 0.03%
Covered Lines: 1767
Relevant Lines: 2432

💛 - Coveralls

@cehbrecht
Copy link
Collaborator

@Zeitsperre can we merge PR #319 before this one?

@Zeitsperre Zeitsperre merged commit f46b44f into master Feb 9, 2024
11 checks passed
@Zeitsperre Zeitsperre deleted the docstring-linting-cleanup branch February 9, 2024 15:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants