Skip to content

Commit 69989ce

Browse files
gfyoungNico Cernek
authored and
Nico Cernek
committed
Clarify referred command for flake8 caveat (pandas-dev#29168)
1 parent da11fc6 commit 69989ce

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

doc/source/development/contributing.rst

+2-1
Original file line numberDiff line numberDiff line change
@@ -618,7 +618,8 @@ from the root of the pandas repository. Now ``black`` and ``flake8`` will be run
618618
each time you commit changes. You can skip these checks with
619619
``git commit --no-verify``.
620620

621-
This command will catch any stylistic errors in your changes specifically, but
621+
One caveat about ``git diff upstream/master -u -- "*.py" | flake8 --diff``: this
622+
command will catch any stylistic errors in your changes specifically, but
622623
be beware it may not catch all of them. For example, if you delete the only
623624
usage of an imported function, it is stylistically incorrect to import an
624625
unused function. However, style-checking the diff will not catch this because

0 commit comments

Comments
 (0)