mikros/rust
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Rollup merge of #127484 - ShE3py:rustdoc-doc-alias-whitespace-doc, r=fmease

Browse Source 
`#[doc(alias)]`'s doc: say that ASCII spaces are allowed

PR #77570 allowed ASCII spaces in doc aliases, but the documentation wasn't updated to say so.

The code checking the aliases:
7fdefb804e/compiler/rustc_passes/src/check_attr.rs (L693-L704)

``````@rustbot`````` label +A-docs
This commit is contained in:
Jacob Pratt 2024-07-10 00:37:12 -04:00 committed by GitHub
commit 85bd32cd69
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
src/doc/rustdoc/src/advanced-features.md
View File

@ -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: