]> 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:

add FAQ entry about undetected syntax errors (#2645)
authorJelle Zijlstra <jelle.zijlstra@gmail.com>
Tue, 30 Nov 2021 20:34:45 +0000 (12:34 -0800)
committerGitHub <noreply@github.com>
Tue, 30 Nov 2021 20:34:45 +0000 (12:34 -0800)
This came up in #2644.

docs/faq.md

index 88bf35b1e6a40d744c60e152ca2456a90054dc85..0a966c99c7f0ec7a07f0b43c2ec16f6fb342476c 100644 (file)
@@ -94,7 +94,14 @@ them in the right place, this detection is not and cannot be perfect. Therefore,
 sometimes have to manually move these comments to the right place after you format your
 codebase with _Black_.
 
-## Can I run black with PyPy?
+## Can I run Black with PyPy?
 
 Yes, there is support for PyPy 3.7 and higher. You cannot format Python 2 files under
 PyPy, because PyPy's inbuilt ast module does not support this.
+
+## Why does Black not detect syntax errors in my code?
+
+_Black_ is an autoformatter, not a Python linter or interpreter. Detecting all syntax
+errors is not a goal. It can format all code accepted by CPython (if you find an example
+where that doesn't hold, please report a bug!), but it may also format some code that
+CPython doesn't accept.