Use the token type Comment, not Comment.Preproc, for RST comments#2598
Merged
birkenfeld merged 1 commit intopygments:masterfrom Nov 28, 2023
Merged
Conversation
Member
|
Yeah, there's no good reason for this. Thanks! |
Collaborator
|
It's not a preprocessor anyways, so yes, this is the right change. |
Collaborator
|
Too slow this morning. More coffee needed apparently to beat @birkenfeld on the job :( |
Anteru
added
A-lexing
jeanas
removed
the
changelog-update
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
While documenting a project that interacts with headers across different file formats, I noticed that RestructuredText comments rendered differently from the others:
For clarity: the difference between RestructuredText comments and other lexers' comments is that all other comments are styled as blue text and italicized, but RestructuredText uses green text and is un-italicized.
The root cause is that RestructuredText comments are given the token type
Comment.Preproc, which is styled uniquely by most styles that I reviewed in Pygments.This PR modifies the token type for RST comments to
Comment. This results in rendering that matches my expectations:Please let me know if anything is amiss here! As always, thanks for your work on Pygments!