]> git.madduck.net Git - etc/vim.git/commitdiff

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

Update discussion of AST safety check in README (#2159)
authorJelle Zijlstra <jelle.zijlstra@gmail.com>
Tue, 27 Apr 2021 21:00:17 +0000 (14:00 -0700)
committerGitHub <noreply@github.com>
Tue, 27 Apr 2021 21:00:17 +0000 (14:00 -0700)
CHANGES.md
README.md

index 37b5da6a40dfb29e0235956b65bd37bd597ac4c3..a30668d33b22399c9a1bc4d60ede7f3276916ec8 100644 (file)
@@ -2,6 +2,11 @@
 
 ### Unreleased
 
 
 ### 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)
 #### _Packaging_
 
 - Install `primer.json` (used by `black-primer` by default) with black. (#2154)
index 8d6adb0567ef487611c6cb91ab4269d96c64932b..c7577fbbd041eaf2a8d4c1230ffaf9b74c7f62d7 100644 (file)
--- a/README.md
+++ b/README.md
@@ -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
 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
 
 
 ## The _Black_ code style