bjoernager/rust
bjoernager/rust
1
Fork 0
Code Activity

Update how-to-read-rustdoc.md

Browse source
This commit is contained in:
Michael Howell 2023-03-31 09:31:44 -07:00
parent afee2411e3
commit 6ce53278e1
1 changed files with 11 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

11
src/doc/rustdoc/src/how-to-read-rustdoc.md
View file

@ -94,6 +94,17 @@ can be matched with the following queries:
* `trait:Iterator<primitive:u32> -> primitive:usize` * `trait:Iterator<primitive:u32> -> primitive:usize`
* `Iterator -> usize` * `Iterator -> usize`
Generics and function parameters are order-agnostic, but sensitive to nesting
and number of matches. For example, a function with the signature
`fn read_all(&mut self: impl Read) -> Result<Vec<u8>, Error>`
will match these queries:
* `Read -> Result<Vec<u8>, Error>`
* `Read -> Result<Error, Vec>`
* `Read -> Result<Vec<u8>>`
But it *does not* match `Result<Vec, u8>` or `Result<u8<Vec>>`.
### Changing displayed theme ### Changing displayed theme
You can change the displayed theme by opening the settings menu (the gear You can change the displayed theme by opening the settings menu (the gear