diff options
| author | Manish Goregaokar <manishsmail@gmail.com> | 2020-07-01 20:35:56 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-07-01 20:35:56 -0700 |
| commit | 8d638f456ac1e1dd4c3194bb40113402377ecf85 (patch) | |
| tree | 960e1335460d21e077604a0545d122fc7ebb25fe | |
| parent | e04070a351f83c6ef89be5344dbcfdee2bfe7180 (diff) | |
| parent | 49c1018d139746f926f1af03d1d4282e0fed7115 (diff) | |
Rollup merge of #73848 - pierwill:pierwill-lexer-block-doc, r=jonas-schievink
Fix markdown rendering in librustc_lexer docs Use back-ticks instead of quotation marks in docs for the block comment variant of TokenKind. ## [Before](https://doc.rust-lang.org/nightly/nightly-rustc/rustc_lexer/enum.TokenKind.html#variant.BlockComment) and after <img width="1103" alt="Screen Shot 2020-06-28 at 1 22 30 PM" src="https://user-images.githubusercontent.com/19642016/85957562-446a8380-b943-11ea-913a-442cf7744083.png"> <img width="1015" alt="Screen Shot 2020-06-28 at 1 28 29 PM" src="https://user-images.githubusercontent.com/19642016/85957566-4af8fb00-b943-11ea-8fef-a09c1d586772.png"> ## Question For visual consistency, should we use back-ticks throughout the docs for these enum variants?
| -rw-r--r-- | src/librustc_lexer/src/lib.rs | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/src/librustc_lexer/src/lib.rs b/src/librustc_lexer/src/lib.rs index 77b3d26463d..2f4b1bbd3ba 100644 --- a/src/librustc_lexer/src/lib.rs +++ b/src/librustc_lexer/src/lib.rs @@ -51,8 +51,9 @@ pub enum TokenKind { // Multi-char tokens: /// "// comment" LineComment, - /// "/* block comment */" - /// Block comments can be recursive, so the sequence like "/* /* */" + /// `/* block comment */` + /// + /// Block comments can be recursive, so the sequence like `/* /* */` /// will not be considered terminated and will result in a parsing error. BlockComment { terminated: bool }, /// Any whitespace characters sequence. |