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

Clarify that Black runs with --safe by default (#3378)

Browse Source
This commit is contained in:
Maximilian Cosmo Sitter 2022-11-10 16:03:19 +01:00 committed by Richard Si
parent 8091b2503d
commit c23a5c15aa
No known key found for this signature in database
GPG Key ID: 33F737A005EDF2DF
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/the_black_code_style/current_style.md
View File

@ -457,9 +457,9 @@ the latter are treated as true raw strings with no special semantics.
### AST before and after formatting ### AST before and after formatting
When run with `--safe`, _Black_ checks that the code before and after is semantically When run with `--safe` (the default), _Black_ checks that the code before and after is
equivalent. This check is done by comparing the AST of the source with the AST of the semantically equivalent. This check is done by comparing the AST of the source with the
target. There are three limited cases in which the AST does differ: AST of the target. There are three limited cases in which the AST does differ:
1. _Black_ cleans up leading and trailing whitespace of docstrings, re-indenting them if 1. _Black_ cleans up leading and trailing whitespace of docstrings, re-indenting them if
needed. It's been one of the most popular user-reported features for the formatter to needed. It's been one of the most popular user-reported features for the formatter to