René's URL Explorer Experiment

Title: STY: Apply pre-commit hooks to codebase by matthewfeickert · Pull Request #22809 · matplotlib/matplotlib · GitHub

Open Graph Title: STY: Apply pre-commit hooks to codebase by matthewfeickert · Pull Request #22809 · matplotlib/matplotlib

X Title: STY: Apply pre-commit hooks to codebase by matthewfeickert · Pull Request #22809 · matplotlib/matplotlib

Description: PR Summary This is a follow up PR to PR #21583 based on discussions in PR #22777 (c.f. #22777 (comment)) and on Gitter. This touches a lot of files so I'll walk through the story here, which should help motivate turning on pre-commit.ci. The pre-commit hooks were added in PR #21583 (November 2021) with a pre-commit.ci matplotlib/.pre-commit-config.yaml Line 3 in a436253 autoupdate_schedule: 'quarterly' though as pre-commit.ci wasn't turned on, there were no pre-commit hook updates coming in on that schedule and so I've run pre-commit autoupdate to update the pre-commit-hooks and flake8 ids. With those updated, I then ran the failing (c.f. #22777 (comment)) pre-commit hooks and applied their necessary revisions as individual commits. So those are the style commits for end-of-file-fixer, trailing-whitespace, and check-docstring-first. These were also done as individual commits so that if in review any of these are viewed as not acceptable they can be dropped easily with a rebase. As the following commits touch many files, this is a noisy first time run of the hooks. To help limit this, add a .git-blame-ignore-revs file that will automatically ignore commits in the blame view on GitHub (this file is required to be in the top level of the repo). This can also be done locally with git blame by running git blame --ignore-revs-file .git-blame-ignore-revs Example on my fork: Note to reviewer: As this file contains commits it is sensitive to rebases, and so please make sure that these commits are correct if anyone rebases this during review. This PR should probably be merged in advance of PR #22777 which can be trivially rebased and would be a good time to turn pre-commit.ci on. pre-commit now passes the full repo: $ pre-commit run --all-files check for added large files..............................................Passed check docstring is first.................................................Passed fix end of files.........................................................Passed mixed line ending........................................................Passed trim trailing whitespace.................................................Passed flake8...................................................................Passed PR Checklist Tests and Styling 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). Documentation is sphinx and numpydoc compliant (the docs should build without error).

Open Graph Description: PR Summary This is a follow up PR to PR #21583 based on discussions in PR #22777 (c.f. #22777 (comment)) and on Gitter. This touches a lot of files so I'll walk through the story here, which sh...

X Description: PR Summary This is a follow up PR to PR #21583 based on discussions in PR #22777 (c.f. #22777 (comment)) and on Gitter. This touches a lot of files so I'll walk through the story here, whic...

Opengraph URL: https://github.com/matplotlib/matplotlib/pull/22809

X: @github

direct link

Domain: github.com

Links:

Viewport: width=device-width