Unverified Commit a9eab85f authored by Felix Hildén's avatar Felix Hildén Committed by GitHub
Browse files

Mention comment non-processing in documentation (#2306)

This commit adds a short section discussing the non-processing of docstrings
besides spacing improvements, mentions comment moving and links to the
AST equivalence discussion. I also added a simple spacing test for good
measure.

Commit history before merge:

* Mention comment non-processing in documentation, add spacing test
* Mention special cases for comment spacing
* Add all special cases, improve wording
parent 40fae181
Loading
Loading
Loading
Loading
+10 −0
Changes for docs/the_black_code_style/current_style.md: 10 added lines, 0 removed lines.
Original line number Diff line number Diff line
@@ -200,6 +200,16 @@ following field or method. This conforms to
_Black_ won't insert empty lines after function docstrings unless that empty line is
required due to an inner function starting immediately after.

### Comments

_Black_ does not format comment contents, but it enforces two spaces between code and a
comment on the same line, and a space before the comment text begins. Some types of
comments that require specific spacing rules are respected: doc comments (`#: comment`),
section comments with long runs of hashes, and Spyder cells. Non-breaking spaces after
hashes are also preserved. Comments may sometimes be moved because of formatting
changes, which can break tools that assign special meaning to them. See
[AST before and after formatting](#ast-before-and-after-formatting) for more discussion.

### Trailing commas

_Black_ will add trailing commas to expressions that are split by comma where each
+2 −2
Changes for tests/data/comments2.py: 2 added lines, 2 removed lines.
Original line number Diff line number Diff line
@@ -159,7 +159,7 @@ def _init_host(self, parsed) -> None:
#######################


instruction()
instruction()#comment with bad spacing

# END COMMENTS
# MORE END COMMENTS
@@ -336,7 +336,7 @@ def _init_host(self, parsed) -> None:
#######################


instruction()
instruction()  # comment with bad spacing

# END COMMENTS
# MORE END COMMENTS