actions/black
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Mention comment non-processing in documentation (#2306)

Browse Source 
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
This commit is contained in:
Felix Hildén 2021-06-09 00:57:23 +03:00 committed by GitHub
parent 40fae18134
commit a9eab85f22
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 12 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/the_black_code_style/current_style.md
View File

@ -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 _Black_ won't insert empty lines after function docstrings unless that empty line is
required due to an inner function starting immediately after. 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 ### Trailing commas
_Black_ will add trailing commas to expressions that are split by comma where each _Black_ will add trailing commas to expressions that are split by comma where each

4
tests/data/comments2.py
View File

@ -159,7 +159,7 @@ def _init_host(self, parsed) -> None:
####################### #######################
instruction() instruction()#comment with bad spacing
# END COMMENTS # END COMMENTS
# MORE END COMMENTS # MORE END COMMENTS
@ -336,7 +336,7 @@ def _init_host(self, parsed) -> None:
####################### #######################
instruction() instruction() # comment with bad spacing
# END COMMENTS # END COMMENTS
# MORE END COMMENTS # MORE END COMMENTS