Skip to content

Commit 00951e1

Browse files
math-and-datadatapythonista
authored andcommitted
PR guide: validate docstring; installing flake8 (#69)
* missing python command for validationg docstring * how to install 'flake8' if needed
1 parent ec8705a commit 00951e1

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

pandas/guide/source/pandas_pr.rst

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ technical parts of the pandas docstring convention. To run the script,
1616
execute in your terminal:
1717

1818
| ``cd <pandas-dir>``
19-
| ``scripts/validate_docstrings.py <your-function-or-method>``
19+
| ``python scripts/validate_docstrings.py <your-function-or-method>``
2020
2121
where `<your-function-or-method>` is for example `pandas.DataFrame.head`,
2222
`pandas.Series.tail` or `pandas.to_datetime`.
@@ -114,6 +114,9 @@ style by running the command:
114114

115115
| ``git diff upstream/master -u -- "*.py" | flake8 --diff``
116116
117+
If you don't already have flake8 installed, you can install it in the Anaconda Prompt it via
118+
| ``conda install flake8``
119+
117120
If the command does not return any warning, mark that checkbox with an X (do
118121
not leave spaces inside the brackets, use `[X]`). If it returns a warning,
119122
fix it, commit your changes, and push to your remote branch before opening

0 commit comments

Comments
 (0)