Skip to content

[rustdoc] Don't generate the "Fields" heading if there is no field displayed #118600

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
bors merged 2 commits into from
Dec 5, 2023
Merged

[rustdoc] Don't generate the "Fields" heading if there is no field displayed #118600

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1c556bb
Don't generate the "Fields" heading if there is no field displayed
GuillaumeGomez Dec 4, 2023
8e53edb
Add regression test for #118195
GuillaumeGomez Dec 4, 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
Next Next commit
Don't generate the "Fields" heading if there is no field displayed
  • Loading branch information
@GuillaumeGomez
GuillaumeGomez committed Dec 4, 2023
commit 1c556bbed4a02a914c152c96c18c04835338ba83
9 changes: 8 additions & 1 deletion src/librustdoc/html/render/print_item.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1737,7 +1737,14 @@ fn item_variants(
w.write_str("</h3></section>");

let heading_and_fields = match &variant_data.kind {
clean::VariantKind::Struct(s) => Some(("Fields", &s.fields)),
clean::VariantKind::Struct(s) => {
// If there is no field to display, no need to add the heading.
if s.fields.iter().any(|f| !f.is_doc_hidden()) {
Some(("Fields", &s.fields))
} else {
None
}
}
clean::VariantKind::Tuple(fields) => {
// Documentation on tuple variant fields is rare, so to reduce noise we only emit
// the section if at least one field is documented.
Expand Down