diff options
| author | Guillaume Gomez <guillaume.gomez@huawei.com> | 2023-06-12 16:42:19 +0200 |
|---|---|---|
| committer | Guillaume Gomez <guillaume.gomez@huawei.com> | 2023-06-14 14:22:17 +0200 |
| commit | 64417c52d6f9d2527464e0fd1cb4d9cf6b516dcd (patch) | |
| tree | 2203e665dc75597d9fff8a4216eb1d016cf345d6 /src/doc/rustdoc | |
| parent | 7dc684f17364952214a5018bacf6b4296109e268 (diff) | |
| download | rust-64417c52d6f9d2527464e0fd1cb4d9cf6b516dcd.tar.gz rust-64417c52d6f9d2527464e0fd1cb4d9cf6b516dcd.zip | |
Add documentation for paths in rustdoc search
Diffstat (limited to 'src/doc/rustdoc')
| -rw-r--r-- | src/doc/rustdoc/src/how-to-read-rustdoc.md | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/src/doc/rustdoc/src/how-to-read-rustdoc.md b/src/doc/rustdoc/src/how-to-read-rustdoc.md index 55cce8ab570..9deb7009cfe 100644 --- a/src/doc/rustdoc/src/how-to-read-rustdoc.md +++ b/src/doc/rustdoc/src/how-to-read-rustdoc.md @@ -110,6 +110,11 @@ Function signature searches also support arrays and slices. The explicit name or array of bytes, while square brackets `[u8]` will match either one. Empty square brackets, `[]`, will match any slice regardless of what it contains. +Paths are supported as well, you can look for `Vec::new` or `Option::Some` or +even `module::module_child::another_child::struct::field`. Whitespace characters +are considered the same as `::`, so if you write `Vec new`, it will be +considered the same as `Vec::new`. + ### Shortcuts Pressing `S` while focused elsewhere on the page will move focus to the |