Skip to content

Fix display of warning block if it is first element of the top doc block #119283

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
merged 3 commits into from
Dec 25, 2023
Merged

Fix display of warning block if it is first element of the top doc block #119283

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2378227
Update browser-ui-test version to 0.16.11
GuillaumeGomez Dec 24, 2023
279b11c
Fix display of warning block if it is first element of the top doc block
GuillaumeGomez Dec 24, 2023
98b71bf
Add GUI regression test for position of warning block
GuillaumeGomez Dec 24, 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
2 changes: 1 addition & 1 deletion src/ci/docker/host-x86_64/x86_64-gnu-tools/browser-ui-test.version
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
0.16.10
0.16.11
3 changes: 3 additions & 0 deletions src/librustdoc/html/static/css/rustdoc.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1367,6 +1367,9 @@ documentation. */
font-weight: bold;
font-size: 1.25rem;
}
.top-doc > .docblock >.warning:first-child::before {
top: 20px;
}

a.test-arrow {
visibility: hidden;
Expand Down
3 changes: 3 additions & 0 deletions tests/rustdoc-gui/src/test_docs/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,9 @@ impl AsRef<str> for Foo {
}
}

/// <div id="doc-warning-0" class="warning">I have warnings!</div>
pub struct WarningStruct;

/// Just a normal enum.
///
/// # title!
Expand Down
13 changes: 13 additions & 0 deletions tests/rustdoc-gui/warning-block.goml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
go-to: "file://" + |DOC_PATH| + "/test_docs/struct.Foo.html"
show-text: true

store-value: (default_y_pos, 5)
define-function: (
"check-warning",
(theme, color, border_color),
Expand All @@ -16,12 +17,18 @@ define-function: (
"border-left": "2px solid " + |border_color|,
"background-color": "transparent",
})
store-position: ("#doc-warning-1", {"y": warn_div_y})
store-position: ("#doc-warning-1::before", {"y": warn_y})
assert: |warn_y| == |warn_div_y| + |default_y_pos|
assert-css: ("#doc-warning-2", {
"margin-bottom": "0px",
"color": |color|,
"border-left": "2px solid " + |border_color|,
"background-color": "transparent",
})
store-position: ("#doc-warning-2", {"y": warn_div_y})
store-position: ("#doc-warning-2::before", {"y": warn_y})
assert: |warn_y| == |warn_div_y| + |default_y_pos|
},
)

Expand All @@ -40,3 +47,9 @@ call-function: ("check-warning", {
"color": "black",
"border_color": "#ff8e00",
})

// We ensure that the warning element in the top doc is not overlaying the "[-]" button.
go-to: "file://" + |DOC_PATH| + "/test_docs/struct.WarningStruct.html"
store-position: ("#doc-warning-0", {"y": warn_div_y})
store-position: ("#doc-warning-0::before", {"y": warn_y})
assert: |warn_y| == |warn_div_y| + |default_y_pos| + 15