Include underlying error when AST safety check parsing fails (#2693)

[etc/vim.git] / docs / faq.md

diff --git a/docs/faq.md b/docs/faq.md
index 72bae6b389df003c70647599d14d83616fb74bde..0a966c99c7f0ec7a07f0b43c2ec16f6fb342476c 100644 (file)
--- a/docs/faq.md
+++ b/docs/faq.md
@@ -47,6 +47,7 @@ _Black_ is timid about formatting Jupyter Notebooks. Cells containing any of the
 following will not be formatted:
 
 - automagics (e.g. `pip install black`)
 following will not be formatted:
 
 - automagics (e.g. `pip install black`)

+- non-Python cell magics (e.g. `%%writeline`)

 - multiline magics, e.g.:
 
   ```python
 - multiline magics, e.g.:
 
   ```python


@@ -93,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_.
 
 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.
 
 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.