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

Docs: clarify fmt:on/off requirements (#2985) (#3048)

Browse Source
This commit is contained in:
Felix Hildén 2022-05-08 03:58:10 +03:00 committed by GitHub
parent 9ce100ba61
commit 62c2b167bc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/the_black_code_style/current_style.md
View File

@ -8,9 +8,10 @@ deliberately limited and rarely added. Previous formatting is taken into account
little as possible, with rare exceptions like the magic trailing comma. The coding style little as possible, with rare exceptions like the magic trailing comma. The coding style
used by _Black_ can be viewed as a strict subset of PEP 8. used by _Black_ can be viewed as a strict subset of PEP 8.
_Black_ reformats entire files in place. It doesn't reformat blocks that start with _Black_ reformats entire files in place. It doesn't reformat lines that end with
`# fmt: off` and end with `# fmt: on`, or lines that ends with `# fmt: skip`. `# fmt: skip` or blocks that start with `# fmt: off` and end with `# fmt: on`.
`# fmt: on/off` have to be on the same level of indentation. It also recognizes `# fmt: on/off` must be on the same level of indentation and in the same block, meaning
no unindents beyond the initial indentation level between them. It also recognizes
[YAPF](https://github.com/google/yapf)'s block comments to the same effect, as a [YAPF](https://github.com/google/yapf)'s block comments to the same effect, as a
courtesy for straddling code. courtesy for straddling code.