Skip to content

Commit 42d3c9f

Browse files
authored
Make note about markdown a note
1 parent 8fae0fd commit 42d3c9f

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

src/comments.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -56,11 +56,11 @@ modules that occupy a source file.
5656

5757
The character `U+000D` (CR) is not allowed in doc comments.
5858

59-
It is conventional for doc comments to contain Markdown, as expected by
60-
`rustdoc`. However, the comment syntax does not respect any internal Markdown.
61-
``/** `glob = "*/*.rs";` */`` terminates the comment at the first `*/`, and the
62-
remaining code would cause a syntax error. This slightly limits the content of
63-
block doc comments compared to line doc comments.
59+
> **Note**: It is conventional for doc comments to contain Markdown, as expected by
60+
> `rustdoc`. However, the comment syntax does not respect any internal Markdown.
61+
> ``/** `glob = "*/*.rs";` */`` terminates the comment at the first `*/`, and the
62+
> remaining code would cause a syntax error. This slightly limits the content of
63+
> block doc comments compared to line doc comments.
6464
6565
> **Note**: The sequence `U+000D` (CR) immediately followed by `U+000A` (LF) would have been previously transformed into a single `U+000A` (LF).
6666

0 commit comments

Comments
 (0)