bjoernager/rust
bjoernager/rust
1
Fork 0
Code Activity

Fix doc comment parsing

Browse source 
This can actually make a difference for the user if they rely on unicode formating.

Prompted by https://github.com/dtolnay/syn/issues/771
This commit is contained in:
kraktus 2022-12-27 13:31:53 +01:00
parent 0ca50032ce
commit ce1e6a4612
1 changed files with 2 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

4
src/doc/rustdoc/src/write-documentation/the-doc-attribute.md
View file

@ -9,11 +9,11 @@ are the same:
```rust,no_run ```rust,no_run
/// This is a doc comment. /// This is a doc comment.
#[doc = " This is a doc comment."] #[doc = r" This is a doc comment."]
# fn f() {} # fn f() {}
``` ```
(Note the leading space in the attribute version.) (Note the leading space and the raw string literal in the attribute version.)
In most cases, `///` is easier to use than `#[doc]`. One case where the latter is easier is In most cases, `///` is easier to use than `#[doc]`. One case where the latter is easier is
when generating documentation in macros; the `collapse-docs` pass will combine multiple when generating documentation in macros; the `collapse-docs` pass will combine multiple