[Python] Add syntax support for sphinx-style doc comments #3839
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
Sphinx (the most common Python documentation tool) uses `#:` comments to signal documentation comments for its "autodoc" module. There is no known overlap with other comment punctuation, so this should be a safe addition. `TM_COMMENT_START_2` is also added to be able to undo the comment using `toggle_comment`, but unfortunately it does not work like this currently because `Default/comment.py` does not prioritize the longest prefix match of all available comment styles but we don't want this style to be the default. https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#directive-autoattribute
FichteFoll
force-pushed
the
pr/python/sphinx-doc-comment
branch
from
246d1e1 to
bbc745c
Compare
keith-hall
approved these changes
Sep 14, 2023
deathaxe
approved these changes
Sep 15, 2023
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.
Sphinx (the most common Python documentation tool) uses
#:comments to signal documentation comments for its "autodoc" module.There is no known overlap with other comment punctuation, so this should be a safe addition.
TM_COMMENT_START_2is also added to be able to undo the comment usingtoggle_comment, but unfortunately it does not work like this currently becauseDefault/comment.pydoes not prioritize the longest prefix match of all available comment styles.https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#directive-autoattribute
Discovered via sublimehq/sublime_text#5587 (comment)