rust-lang / reference

The Rust Reference
https://doc.rust-lang.org/nightly/reference/
Apache License 2.0
1.25k stars 490 forks source link

Document limitations on block doc comments #1602

Closed GKFX closed 2 months ago

GKFX commented 2 months ago

It is unintuitive that the Markdown contained within doc comments is not actually part of their syntax, as evidenced in the linked issue. This can result in certain block doc comments parsing (or rather, failing to parse) in an unintuitive way.

Closes rust-lang/rust#129685.