diff options
| author | Lieselotte <52315535+she3py@users.noreply.github.com> | 2024-07-08 23:12:31 +0200 |
|---|---|---|
| committer | Lieselotte <52315535+she3py@users.noreply.github.com> | 2024-07-09 00:16:06 +0200 |
| commit | ec662e7606c9d03de536bbf46dbdeb0d6140bc85 (patch) | |
| tree | 011cab55163f862a3e58596a7646993269bd62ab /src/doc/rustdoc | |
| parent | 32e692681e457b06efedd05c5a4be0d718f39292 (diff) | |
| download | rust-ec662e7606c9d03de536bbf46dbdeb0d6140bc85.tar.gz rust-ec662e7606c9d03de536bbf46dbdeb0d6140bc85.zip | |
`#[doc(alias)]`'s doc: say that ASCII spaces are allowed
Diffstat (limited to 'src/doc/rustdoc')
| -rw-r--r-- | src/doc/rustdoc/src/advanced-features.md | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/src/doc/rustdoc/src/advanced-features.md b/src/doc/rustdoc/src/advanced-features.md index 1733c8fc9a2..4a1c0916253 100644 --- a/src/doc/rustdoc/src/advanced-features.md +++ b/src/doc/rustdoc/src/advanced-features.md @@ -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: |