Document black escape hatch

python-trio · May 22, 2020 · 3a88e51 · 3a88e51
1 parent 00aabdc
commit 3a88e51
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/docs/source/contributing.rst b/docs/source/contributing.rst
@@ -300,6 +300,9 @@ will let you focus on more important style issues like choosing good
 names, writing useful comments, and making sure your docstrings are
 nicely formatted. (black doesn't reformat comments or docstrings.)
 
+Very occasionally, you'll want to override black formatting. To do so,
+you can can add `# fmt: off` and `# fmt: on` comments.
+
 If you want to see what changes black will make, you can use::
 
     black --diff setup.py trio