Skip to content

Commit

Permalink
Make note about markdown a note
Browse files Browse the repository at this point in the history
  • Loading branch information
ehuss authored Sep 17, 2024
1 parent 8fae0fd commit 42d3c9f
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions src/comments.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,11 +56,11 @@ modules that occupy a source file.

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

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

0 comments on commit 42d3c9f

Please sign in to comment.