Skip to content

rustdoc: Allow whitespace as path separator like double colon #108537

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Jul 2, 2023
Merged

rustdoc: Allow whitespace as path separator like double colon #108537

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
b99bf46
Use whitespace as path separator like double colon
GuillaumeGomez Jun 12, 2023
b5f8258
Update rustdoc-js-std tests
GuillaumeGomez Jun 12, 2023
7dc684f
Add "vec new" test
GuillaumeGomez Jun 12, 2023
64417c5
Add documentation for paths in rustdoc search
GuillaumeGomez Jun 12, 2023
d1a76a9
Update rustdoc-gui test
GuillaumeGomez Jun 12, 2023
4f0a912
Correctly display whitespace characters in search error
GuillaumeGomez Jun 13, 2023
e4ee329
Fix eBNF and handling of whitespace characters when not in a path
GuillaumeGomez Jun 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions src/doc/rustdoc/src/how-to-read-rustdoc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading