Run black on .py files (with git-blame-ignore-revs)
#575
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
See https://black.readthedocs.io/en/stable/guides/introducing_black_to_your_project.html#avoiding-ruining-git-blame and https://docs.github.com/en/repositories/working-with-files/using-files/viewing-a-file#ignore-commits-in-the-blame-view Tested that this works out of the box in the GitHub UI, and locally after running: git config blame.ignoreRevsFile .git-blame-ignore-revs
The check to run is: ``` pydocstyle . --ignore=D401,D212,D413,D100 --match='(?!_types.py).*\.py' ``` `_types.py` is excluded because it's a private file, and it's too fiddly and not necessary to add docstrings to the classes in that file.
13 tasks
|
One comment: this PR should be merged with a merge commit, rather than squash-merged, in order for the commit hash in the |
|
It'd be nice to collect all these nice tool usage guide in one place 👍 |
|
@leofang I assume you mean black, not the git blame twiddling? One of the remaining TODO tasks is to have a single CI job that runs all these tools. We can also add it to CONTRIBUTING.md if that's helpful. |
|
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This makes
blackhappy, andgit blamewon't be cluttered by the commit withblackchanges. This works in the GitHub UI out of the box, and locally after runninggit config blame.ignoreRevsFile .git-blame-ignore-revsonce.This PR also fixes some minor issues identified by
pydocstyle. There is no good automated formatter for docstrings (blackdoesn't touch them, anddocformattertouches only summary lines and descriptions, which is a small fraction of content). So in anticipation of adding CI in the future, this makes the following check pass:This is all that can be done with automated tooling. xref gh-533 for context.