ANN: highlight emphasis and strong emphasis in rustdocs #7347
Conversation
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
Undin
reviewed
Jun 16, 2021
Well... We can't parse it for now. Common Mark Markdown flavor doesn't specify struck-out text. (but rustdoc understand it) |
vlad20012
force-pushed
the
parse-rust-docs-highlighting-emphasis
branch
2 times, most recently
from
bd0427a to
792ee12
Compare
Undin
reviewed
Jun 18, 2021
| <DOC_COMMENT>/// Some documentation <DOC_CODE>`with a code`</DOC_CODE>, <DOC_EMPHASIS>*an italic text*</DOC_EMPHASIS> | ||
| /// and <DOC_STRONG>**a bold text**</DOC_STRONG> | ||
| /// <DOC_HEADING># Heading</DOC_HEADING> | ||
| /// <DOC_LINK>[Rust](https://www.rust-lang.org/)</DOC_LINK></DOC_COMMENT> |
vlad20012
force-pushed
the
parse-rust-docs-highlighting-emphasis
branch
from
792ee12 to
04fdbdc
Compare
|
bors r=undin |
|
Build succeeded: |
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.
Depends on #6502
highlight *emphasis* and **strong emphasis** text in rustdocs.
I'm not sure what color scheme should be used by default for *emphasis* text. It's assumed to be italic, but both default Light and Darcula themes highlight all doc comments as italic, hence plain italic *emphasis* would be indistinguishable from a regular doc text. I've used a scheme from #3739 where *strong emphasis* is highlighted as bold and *emphasis* is highlighted as italic and bold simultaneously.
Closes #3739
changelog: highlight *emphasis* and **strong emphasis** text in rustdocs