Skip to content

Commit 7c6bfc9

Browse files
committed
Update dev guide to reflect switch from pycodestyle to black
Follow-on to code and CI pipeline changes in #935 Fixes #933
1 parent 0667750 commit 7c6bfc9

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

docs/dev-guide.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -67,8 +67,8 @@ Here's a quick checklist to follow when coding to ensure a good pull request
6767
goal.
6868
- Ensure all indentation is done as 4-spaces and your editor is set to unix line
6969
endings.
70-
- The code matches PEP8 style guides. Make sure to run
71-
`pycodestyle tableauserverclient test samples` to catch and fix any style
70+
- The code matches PEP8 style guides, enforced by the black formatter. Make sure to run
71+
`black --check --line-length 120 tableauserverclient samples test` to catch and fix any style
7272
issues before submitting your pull request.
7373
- Keep commit messages clean and descriptive.
7474

@@ -84,7 +84,7 @@ Create a file `pre-commit` with the contents below and mark it as executable
8484

8585
To test that the hook is working correctly, make a style-inconsistent change (for
8686
example, changing some indentation to not be a multiple of 4), then try to commit
87-
locally. You should get a failure with an explanation from pycodestyle with the
87+
locally. You should get a failure with an explanation from black with the
8888
issue.
8989

9090
```shell
@@ -94,8 +94,8 @@ issue.
9494
if [ -e tableauserverclient/__init__.py ];
9595
then
9696
# check for style conventions in all code dirs
97-
echo Running pycodestyle
98-
pycodestyle tableauserverclient test samples
97+
echo Running black format check
98+
black --check --line-length 120 tableauserverclient samples test
9999
fi
100100
```
101101

0 commit comments

Comments
 (0)