Skip to content

MNT: Update pre-commit hooks #24196

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 3 commits into from
Oct 20, 2022
Merged

MNT: Update pre-commit hooks #24196

merged 3 commits into from
Oct 20, 2022

Conversation

matthewfeickert
Copy link
Contributor

@matthewfeickert matthewfeickert commented Oct 17, 2022 •
edited
Loading

PR Summary

Update the codespell pre-commit hook, and while doing so also update the flake8 pre-commit hook.

Note that this PR would eventually be done by the quarterly update, and so feel free to close if you'd prefer to wait for that, but this takes care of additional updates now.

Follow up PR to PR #22809.

Closes #24086

PR Checklist

Tests and Styling

  • [N/A] Has pytest style unit tests (and pytest passes).
  • Is Flake 8 compliant (install flake8-docstrings and run flake8 --docstring-convention=all).

Documentation

  • [N/A] New features are documented, with examples if plot related.
  • [N/A] New features have an entry in doc/users/next_whats_new/ (follow instructions in README.rst there).
  • [N/A] API changes documented in doc/api/next_api_changes/ (follow instructions in README.rst there).
  • [N/A] Documentation is sphinx and numpydoc compliant (the docs should build without error).

matthewfeickert
matthewfeickert commented Oct 17, 2022
View reviewed changes
Copy link
Contributor Author

@matthewfeickert matthewfeickert left a comment

Choose a reason for hiding this comment

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

Summary of why each of these changes is applied:

ci/codespell-ignore-words.txt
@@ -4,13 +4,18 @@ ba
cannotation
coo
curvelinear
dedented
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Use in

matplotlib/lib/matplotlib/axes/_base.py

Line 48 in 23730b4

dedented docstring; additional replacements can by given in *doc_sub*.

is reasonable so adding to ignore.

ci/codespell-ignore-words.txt
@@ -4,13 +4,18 @@ ba
cannotation
coo
curvelinear
dedented
falsy
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Falsy is how Python spells it, so adding.

ci/codespell-ignore-words.txt
flate
hax
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Use in

matplotlib/examples/lines_bars_and_markers/vline_hline_demo.py

Line 20 in 23730b4

fig, (vax, hax) = plt.subplots(1, 2, figsize=(12, 6))

for "horizontal axis" is reasonable, so added. However, if it would be preferable to make the example variables more explicit and verbose I can edit them instead.

ci/codespell-ignore-words.txt
hist
inh
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Use in

matplotlib/lib/matplotlib/transforms.py

Line 2562 in 23730b4

inl, inb, inw, inh = self._boxin.bounds

for "invalid height" is reasonable, so added.

ci/codespell-ignore-words.txt
nd
oly
sur
resizeable
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Use in

matplotlib/doc/devel/MEP/MEP09.rst

Line 9 in 23730b4

artist resizeable, moveable, highlightable, and selectable as desired

is a valid spelling, and so adding to ignore file.

sur is removed as added to the codespell dictionary in v2.2.0. c.f. codespell-project/codespell#2300

@matthewfeickert
Copy link
Contributor Author

As this is a follow up to PR #22809, then tagging @oscargus, @greglucas, @jklymak, and @QuLogic for possible reviewers.

oscargus
oscargus approved these changes Oct 17, 2022
View reviewed changes
Copy link
Member

@oscargus oscargus 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! Replaces #24086?

@matthewfeickert
Copy link
Contributor Author

matthewfeickert commented Oct 17, 2022 •
edited
Loading

Looks good! Replaces #24086?

oh woops! I missed this, sorry @oscargus. Yes, I can either add to the PR body that this will close it or if it would be preferred we can port the additional updates and codespell changes from here over to that PR — your call.

@oscargus
Copy link
Member

To me it seems like just closing #24086 when this is merged would be the way to go.
(Unless the pre-commit-ci-bot thinks it is a bad idea for some unknown reason...)

@matthewfeickert
Copy link
Contributor Author

matthewfeickert commented Oct 17, 2022 •
edited
Loading

That's totally fine! The pre-commit.ci bot doesn't care at all. I'll just be better in the future about checking for those PRs before opening another one. I've updated the PR body to close PR #24086 automatically now.

@matthewfeickert matthewfeickert mentioned this pull request Oct 17, 2022
Closed
@matthewfeickert matthewfeickert force-pushed the mnt/update-pre-commit-hooks branch from bb6702b to 7e2b17c Compare October 17, 2022 21:21
@matthewfeickert
MNT: Update pre-commit hooks
5fd39c7 
* github.com/pycqa/flake8: v4.0.1 → v5.0.4
* github.com/codespell-project/codespell: v2.1.0 → v2.2.2
@matthewfeickert
MNT: Rename 'nam' to 'name' for clarity
b33ed28 
* Use 'name' to additionally avoid codespell failure.
@matthewfeickert
MNT: Update words in codespell-ignore-words file
b41e130 
Ignore instances of:
* 'dedented', 'resizeable'
* 'falsy' for Falsy in Python
* 'hax' for horizontal axis
* 'inh' for invalid height

Remove ignore of 'sur' as it is in codespell's dictionary as of v2.2.0.
   - c.f. https://github.com/codespell-project/codespell/releases/tag/v2.2.0
@matthewfeickert matthewfeickert force-pushed the mnt/update-pre-commit-hooks branch from 7e2b17c to b41e130 Compare October 19, 2022 07:11
@QuLogic QuLogic merged commit aaa5129 into matplotlib:main Oct 20, 2022
@QuLogic QuLogic added this to the v3.7.0 milestone Oct 20, 2022
@matthewfeickert matthewfeickert deleted the mnt/update-pre-commit-hooks branch October 20, 2022 06:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@QuLogic QuLogic QuLogic approved these changes

@oscargus oscargus oscargus approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
v3.7.0
Development

Successfully merging this pull request may close these issues.
3 participants
@matthewfeickert @oscargus @QuLogic