diff options
| author | Urgau <urgau@numericable.fr> | 2023-08-28 10:00:26 +0200 |
|---|---|---|
| committer | Urgau <urgau@numericable.fr> | 2023-08-28 14:03:33 +0200 |
| commit | 85e4b89cf615c112c72243a2d8f4a55010ecbd4b (patch) | |
| tree | 4953449194aad9e00b561fa5fa68f6f9bc3d10e5 | |
| parent | 706d010c8b590f40cc2fb3de7b744d9a59a93ac9 (diff) | |
| download | rust-85e4b89cf615c112c72243a2d8f4a55010ecbd4b.tar.gz rust-85e4b89cf615c112c72243a2d8f4a55010ecbd4b.zip | |
rustdoc: start new "Sections" section in the book with Aliased Type
| -rw-r--r-- | src/doc/rustdoc/src/how-to-read-rustdoc.md | 16 |
1 files changed, 16 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 9deb7009cfe..cd6e29ffd66 100644 --- a/src/doc/rustdoc/src/how-to-read-rustdoc.md +++ b/src/doc/rustdoc/src/how-to-read-rustdoc.md @@ -38,6 +38,22 @@ followed by a list of fields or variants for Rust types. Finally, the page lists associated functions and trait implementations, including automatic and blanket implementations that `rustdoc` knows about. +### Sections + +<!-- FIXME: Implementations --> +<!-- FIXME: Trait Implementations --> +<!-- FIXME: Implementors --> +<!-- FIXME: Auto Trait Implementations --> + +#### Aliased Type + +A type alias is expanded at compile time to its +[aliased type](https://doc.rust-lang.org/reference/items/type-aliases.html). +That may involve substituting some or all of the type parameters in the target +type with types provided by the type alias definition. The Aliased Type section +shows the result of this expansion, including the types of public fields or +variants, which may depend on those substitutions. + ### Navigation Subheadings, variants, fields, and many other things in this documentation |