DOC: update contributing guidelines for black #27233
Merged
Conversation
This file contains hidden or 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
| to automatically run ``black`` and ``flake8`` when you make a git commit. This | ||
| can be done by installing ``pre-commit``:: | ||
|
|
||
| pip install pre-commit |
There was a problem hiding this comment.
It seems that the conda-forge package is pre_commit (that's a bit an annoying name difference ..)
| @@ -1,4 +1,5 @@ | |||
| - [ ] closes #xxxx | |||
| - [ ] tests added / passed | |||
| - [ ] passes `black pandas` | |||
| - [ ] passes `git diff upstream/master -u -- "*.py" | flake8 --diff` | |||
There was a problem hiding this comment.
what should we be recommending here? Still keep both flake8 and black?
The problem with this version of the black command is also that it does the full code base and takes a while
There was a problem hiding this comment.
make black is pretty fast currently so i would just have this
| hooks: | ||
| - id: black | ||
| language_version: python3.7 | ||
| - repo: https://gitlab.com/pycqa/flake8 |
There was a problem hiding this comment.
@TomAugspurger do you know if there is a difference taking flake8 from its own repo or from the pre-commit-hooks repo?
In #23616 you use the pre-commit-hooks one, but in a recent gitter chat you pasted the above?
jreback
reviewed
Jul 5, 2019
|
ok lgtm. |
1 task
|
thanks @jorisvandenbossche |
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.
Closes #27226
Starting this by copying some content from dask (dask/dask#4983)
Also related to #23616 (recommending pre-commit hooks)