Commit c0945f0

authored

Rollup merge of rust-lang#123116 - chloekek:rustdoc-variant-swap-fields-doc, r=GuillaumeGomez

rustdoc: Swap fields and variant documentations Previously, the documentation for a variant appeared after the documentation for each of its fields. This was inconsistent with structs and unions, and made little sense on its own; fields are subordinate to variants and should therefore appear later in the documentation. Before: ![Screenshot of rendered documentation before this patch.](https://github.com/rust-lang/rust/assets/50083900/4c98258e-bdf7-4507-9cf1-fe601407ff11) After: ![Screenshot of rendered documentation after this patch.](https://github.com/rust-lang/rust/assets/50083900/bd223f92-9b06-4b5a-820e-7a8501bdc0e2)

2 parents 64a9360 + 1942f95 commit c0945f0Copy full SHA for c0945f0

File tree

-2

lines changed

-2

lines changed

Lines changed: 2 additions & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -1728,6 +1728,8 @@ fn item_variants(`
`1728`	`1728`	`}`
`1729`	`1729`	`w.write_str("</h3></section>");`
`1730`	`1730`
	`1731`	`+ write!(w, "{}", document(cx, variant, Some(it), HeadingOffset::H4));`
	`1732`	`+`
`1731`	`1733`	`let heading_and_fields = match &variant_data.kind {`
`1732`	`1734`	`clean::VariantKind::Struct(s) => {`
`1733`	`1735`	`// If there is no field to display, no need to add the heading.`
`@@ -1789,8 +1791,6 @@ fn item_variants(`
`1789`	`1791`	`}`
`1790`	`1792`	`w.write_str("</div>");`
`1791`	`1793`	`}`
`1792`		`-`
`1793`		`- write!(w, "{}", document(cx, variant, Some(it), HeadingOffset::H4));`
`1794`	`1794`	`}`
`1795`	`1795`	`write!(w, "</div>");`
`1796`	`1796`	`}`

Comments

(0)