Mention comment non-processing in documentation #2306
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
JelleZijlstra
added
the
skip news
felix-hilden
commented
Jun 6, 2021
ichard26
approved these changes
Jun 8, 2021
There was a problem hiding this comment.
Looking good!
I was going to suggest adding how Black tries extra hard for certain pragma comments to avoiding them, but I ended up deciding against it because it's not a guarantee so not exactly useful to readers :P (also it's mentioned in the linked AST safety section anyway)
Thanks a million!
JelleZijlstra
approved these changes
Jun 8, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #1017: This PR 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.
skip news? Anything to add or improve?