Unverified Commit 807a65f9 authored by Jelle Zijlstra's avatar Jelle Zijlstra Committed by GitHub
Browse files

Update discussion of AST safety check in README (#2159)

parent 76e1602d
Loading
Loading
Loading
Loading
+5 −0
Changes for CHANGES.md: 5 added lines, 0 removed lines.
Original line number Diff line number Diff line
@@ -2,6 +2,11 @@

### Unreleased

#### _Black_

- Clarify that _Black_ may change the AST, especially when cleaning up docstrings.
  (#2159)

#### _Packaging_

- Install `primer.json` (used by `black-primer` by default) with black. (#2154)
+4 −2
Changes for README.md: 4 added lines, 2 removed lines.
Original line number Diff line number Diff line
@@ -238,8 +238,10 @@ change in the future**. That being said, no drastic stylistic changes are planne
mostly responses to bug reports.

Also, as a temporary safety measure, _Black_ will check that the reformatted code still
produces a valid AST that is equivalent to the original. This slows it down. If you're
feeling confident, use `--fast`.
produces a valid AST that is mostly equivalent to the original. This slows it down. If
you're feeling confident, use `--fast`. In a few contexts, Black does make changes to
the AST: it cleans up whitespace in docstrings, adds or removes parentheses in some
`del` statements, and may move around type comments.

## The _Black_ code style