Skip to content

Commit 85e4b89

Browse files
committed
rustdoc: start new "Sections" section in the book with Aliased Type
1 parent 706d010 commit 85e4b89

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

src/doc/rustdoc/src/how-to-read-rustdoc.md

+16
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,22 @@ followed by a list of fields or variants for Rust types.
3838
Finally, the page lists associated functions and trait implementations,
3939
including automatic and blanket implementations that `rustdoc` knows about.
4040

41+
### Sections
42+
43+
<!-- FIXME: Implementations -->
44+
<!-- FIXME: Trait Implementations -->
45+
<!-- FIXME: Implementors -->
46+
<!-- FIXME: Auto Trait Implementations -->
47+
48+
#### Aliased Type
49+
50+
A type alias is expanded at compile time to its
51+
[aliased type](https://doc.rust-lang.org/reference/items/type-aliases.html).
52+
That may involve substituting some or all of the type parameters in the target
53+
type with types provided by the type alias definition. The Aliased Type section
54+
shows the result of this expansion, including the types of public fields or
55+
variants, which may depend on those substitutions.
56+
4157
### Navigation
4258

4359
Subheadings, variants, fields, and many other things in this documentation

0 commit comments

Comments
 (0)