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

Synchronize code formatters with pre-commit #1626

Merged
merged 10 commits into from
Jan 26, 2024
Merged

Conversation

Zeitsperre
Copy link
Collaborator

@Zeitsperre Zeitsperre commented Jan 26, 2024

Pull Request Checklist:

  • This PR addresses an already opened issue (for bug fixes / features)
  • Tests for the changes have been added (for bug fixes / features)
    • (If applicable) Documentation has been added / updated (for bug fixes / features)
  • CHANGES.rst has been updated (with summary of main changes)
    • Link to issue (:issue:number) and pull request (:pull:number) has been added

What kind of change does this PR introduce?

  • Updates the pre-commit hook versions.
  • black is now using year-2024 style conventions.
  • Pins the dev recipe-listed code formatters (black, blackdoc, isort) to match their pre-commit equivalents.
  • Updates these pinned versions in the tox.ini.
  • isort (currently used in Makefile) has been added to the dev recipe and environment.yml
  • Set the environment.yml to use the PyPI-provided bump-my-version package.

Does this PR introduce a breaking change?

Yes. black 24.1.0 introduces several aesthetic changes to the code. isort is now listed as a dependency. Both black and isort (and blackdoc) are now pinned to prevent pre-commit and tox formatting disagreements.

Other information:

https://github.com/psf/black/releases/tag/24.1.0
callowayproject/bump-my-version#129

@Zeitsperre Zeitsperre added the dependencies Pull requests that update a dependency file label Jan 26, 2024
@Zeitsperre Zeitsperre added this to the v0.48.0 milestone Jan 26, 2024
@Zeitsperre Zeitsperre requested a review from aulemahal January 26, 2024 16:49
@Zeitsperre Zeitsperre self-assigned this Jan 26, 2024
@github-actions github-actions bot added the CI Automation and Contiunous Integration label Jan 26, 2024
@github-actions github-actions bot added sdba Issues concerning the sdba submodule. API Interfacing and User Concerns docs Improvements to documenation indicators Climate indices and indicators labels Jan 26, 2024
Copy link
Collaborator

@aulemahal aulemahal left a comment

Choose a reason for hiding this comment

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

Looks good.

@github-actions github-actions bot added the approved Approved for additional tests label Jan 26, 2024
@Zeitsperre Zeitsperre merged commit b6b9299 into master Jan 26, 2024
18 checks passed
@Zeitsperre Zeitsperre deleted the synchronize-formatters branch January 26, 2024 17:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
API Interfacing and User Concerns approved Approved for additional tests CI Automation and Contiunous Integration dependencies Pull requests that update a dependency file docs Improvements to documenation indicators Climate indices and indicators sdba Issues concerning the sdba submodule.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants