Skip to content

Commit

Permalink
Auto merge of rust-lang#119283 - GuillaumeGomez:warning-block-pos, r=…
Browse files Browse the repository at this point in the history
…notriddle

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

It fixes the display of the warning block "i" element in case it is the first element:

![Screenshot from 2023-12-23 11-15-48](https://github.com/rust-lang/rust/assets/3050060/99b6796e-2a09-4053-813e-84288ce76c4c)

It now looks like this:

![image](https://github.com/rust-lang/rust/assets/3050060/306b4cf1-3a7d-4681-b0cf-3e721186bfe8)

The update for the `browser-ui-test` framework is because it didn't detect correctly pseudo elements if they ended with a digit or a dash.

r? `@notriddle`
  • Loading branch information
bors committed Dec 25, 2023
2 parents 471dcbd + 98b71bf commit b87f649
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 1 deletion.
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
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
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
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

0 comments on commit b87f649

Please sign in to comment.