Skip to content

docs: Refactor pycodestyle/Flake8 compatibility docs #4194

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 11 commits into from
Feb 2, 2024
Merged

docs: Refactor pycodestyle/Flake8 compatibility docs #4194

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
ee64f37
Document E701 in using_black_with_other_tools.md
cobaltt7 Jan 29, 2024
034029e
Update current_style.md
cobaltt7 Jan 29, 2024
23367c3
Update .flake8
cobaltt7 Jan 29, 2024
203f7cc
docs: Refactor pycodestyle/Flake8 compatibility docs
cobaltt7 Jan 31, 2024
0a4cd49
Merge branch 'main' into patch-1
cobaltt7 Jan 31, 2024
6281f48
docs: Fix links
cobaltt7 Jan 31, 2024
abe43cf
Update docs/guides/using_black_with_other_tools.md
cobaltt7 Feb 1, 2024
330f550
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Feb 1, 2024
2c1a0c3
or pass
cobaltt7 Feb 1, 2024
6c6ce48
Apply suggestions from code review
cobaltt7 Feb 1, 2024
a9d28ae
actually, black does not condense `pass`
cobaltt7 Feb 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .flake8
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[flake8]
# B905 should be enabled when we drop support for 3.9
ignore = E203, E266, E501, E704, W503, B905, B907
ignore = E203, E266, E501, E701, E704, W503, B905, B907
# line length is intentionally set to 80 here because black uses Bugbear
# See https://black.readthedocs.io/en/stable/the_black_code_style/current_style.html#line-length for more details
max-line-length = 80
Expand Down
8 changes: 4 additions & 4 deletions docs/guides/using_black_with_other_tools.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ There are a few deviations that cause incompatibilities with _Black_.

```
max-line-length = 88
extend-ignore = E203, E704
extend-ignore = E203, E701, E704
```

#### Why those options above?
Expand Down Expand Up @@ -173,7 +173,7 @@ limit of `88`, _Black_'s default. This explains `max-line-length = 88`.
```ini
[flake8]
max-line-length = 88
extend-ignore = E203, E704
extend-ignore = E203, E701, E704
```

</details>
Expand All @@ -184,7 +184,7 @@ extend-ignore = E203, E704
```ini
[flake8]
max-line-length = 88
extend-ignore = E203, E704
extend-ignore = E203, E701, E704
```

</details>
Expand All @@ -195,7 +195,7 @@ extend-ignore = E203, E704
```ini
[flake8]
max-line-length = 88
extend-ignore = E203, E704
extend-ignore = E203, E701, E704
```

</details>
Expand Down
4 changes: 2 additions & 2 deletions docs/the_black_code_style/current_style.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ If you use Flake8, you have a few options:
max-line-length = 80
...
select = C,E,F,W,B,B950
extend-ignore = E203, E501, E704
extend-ignore = E203, E501, E701, E704
```

The rationale for B950 is explained in
Expand All @@ -177,7 +177,7 @@ If you use Flake8, you have a few options:
```ini
[flake8]
max-line-length = 88
extend-ignore = E203, E704
extend-ignore = E203, E701, E704
```

An explanation of why E203 is disabled can be found in the [Slices section](#slices) of
Expand Down