From 64417c52d6f9d2527464e0fd1cb4d9cf6b516dcd Mon Sep 17 00:00:00 2001 From: Guillaume Gomez Date: Mon, 12 Jun 2023 16:42:19 +0200 Subject: [PATCH] Add documentation for paths in rustdoc search --- src/doc/rustdoc/src/how-to-read-rustdoc.md | 5 +++++ 1 file changed, 5 insertions(+) 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