actions/black
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update pylint config docs (#2931)

Browse Source
This commit is contained in:
Joseph Young 2022-03-16 17:00:30 +00:00 committed by GitHub
parent 086ae68076
commit fa7f01592b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 6 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CHANGES.md
View File

@ -32,6 +32,8 @@
<!-- Major changes to documentation and policies. Small docs changes
don't need a changelog entry. -->
- Update pylint config documentation (#2931)
### Integrations
<!-- For example, Docker, GitHub Actions, pre-commit, editors -->

3
docs/compatible_configs/pylint/pylintrc
View File

@ -1,5 +1,2 @@
[MESSAGES CONTROL]
disable = C0330, C0326
[format]
max-line-length = 88

3
docs/compatible_configs/pylint/pyproject.toml
View File

@ -1,5 +1,2 @@
[tool.pylint.messages_control]
disable = "C0330, C0326"
[tool.pylint.format]
max-line-length = "88"

3
docs/compatible_configs/pylint/setup.cfg
View File

@ -1,5 +1,2 @@
[pylint]
max-line-length = 88
[pylint.messages_control]
disable = C0330, C0326

32
docs/guides/using_black_with_other_tools.md
View File

@ -210,31 +210,16 @@ mixed feelings about _Black_'s formatting style.
#### Configuration
```
disable = C0326, C0330
max-line-length = 88
```
#### Why those options above?
When _Black_ is folding very long expressions, the closing brackets will
[be dedented](../the_black_code_style/current_style.md#how-black-wraps-lines).
Pylint should be configured to only complain about lines that surpass `88` characters
via `max-line-length = 88`.
```py3
ImportantClass.important_method(
exc, limit, lookup_lines, capture_locals, callback
)
```
Although this style is PEP 8 compliant, Pylint will raise
`C0330: Wrong hanging indentation before block (add 4 spaces)` warnings. Since _Black_
isn't configurable on this style, Pylint should be told to ignore these warnings via
`disable = C0330`.
Also, since _Black_ deals with whitespace around operators and brackets, Pylint's
warning `C0326: Bad whitespace` should be disabled using `disable = C0326`.
And as usual, Pylint should be configured to only complain about lines that surpass `88`
characters via `max-line-length = 88`.
If using `pylint<2.6.0`, also disable `C0326` and `C0330` as these are incompatible with
_Black_ formatting and have since been removed.
#### Formats
@ -242,9 +227,6 @@ characters via `max-line-length = 88`.
<summary>pylintrc</summary>
```ini
[MESSAGES CONTROL]
disable = C0326, C0330
[format]
max-line-length = 88
```
@ -257,9 +239,6 @@ max-line-length = 88
```cfg
[pylint]
max-line-length = 88
[pylint.messages_control]
disable = C0326, C0330
```
</details>
@ -268,9 +247,6 @@ disable = C0326, C0330
<summary>pyproject.toml</summary>
```toml
[tool.pylint.messages_control]
disable = "C0326, C0330"
[tool.pylint.format]
max-line-length = "88"
```