Skip to content

Commit

Permalink
#[doc(alias)]'s doc: say that ASCII spaces are allowed
Browse files Browse the repository at this point in the history
Co-authored-by: Trevor Gross <[email protected]>
  • Loading branch information
ShE3py and tgross35 committed Jul 8, 2024
1 parent 32e6926 commit 1356424
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion src/doc/rustdoc/src/advanced-features.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,8 @@ pub struct BigX;
Then, when looking for it through the `rustdoc` search, if you enter "x" or
"big", search will show the `BigX` struct first.

There are some limitations on the doc alias names though: you can't use `"` or whitespace.
There are some limitations on the doc alias names though: they cannot contain quotes (`'`, `"`)
or most whitespace. ASCII space is allowed if it does not start or end the alias.

You can add multiple aliases at the same time by using a list:

Expand Down

0 comments on commit 1356424

Please sign in to comment.