Auto merge of #106561 - GuillaumeGomez:warning-block, r=rustdoc
Add warning block support in rustdoc Fixes https://github.com/rust-lang/rust/issues/79710. You can test it [here](https://rustdoc.crud.net/imperio/warning-block/foo/struct.Foo.html). It currently looks like this:  So a few things to note: * Since it's a new add and it's changing the UI, we'll need to go through an FCP. * Does the UI looks good? * Is the way picked to add a warning block ok for everyone? The discussion on the issue seemed to be in favour of this solution but it doesn't hurt to double-check. cc `@rust-lang/rustdoc`
This commit is contained in:
commit
5e9d3d8a03
7 changed files with 96 additions and 3 deletions
|
@ -65,6 +65,18 @@ impl Foo {
|
|||
pub fn must_use(&self) -> bool {
|
||||
true
|
||||
}
|
||||
|
||||
/// hello
|
||||
///
|
||||
/// <div id="doc-warning-1" class="warning">this is a warning</div>
|
||||
///
|
||||
/// done
|
||||
pub fn warning1() {}
|
||||
|
||||
/// Checking there is no bottom margin if "warning" is the last element.
|
||||
///
|
||||
/// <div id="doc-warning-2" class="warning">this is a warning</div>
|
||||
pub fn warning2() {}
|
||||
}
|
||||
|
||||
impl AsRef<str> for Foo {
|
||||
|
|
45
tests/rustdoc-gui/warning-block.goml
Normal file
45
tests/rustdoc-gui/warning-block.goml
Normal file
|
@ -0,0 +1,45 @@
|
|||
// Test to check that the "warning blocks" are displayed as expected.
|
||||
go-to: "file://" + |DOC_PATH| + "/test_docs/struct.Foo.html"
|
||||
show-text: true
|
||||
|
||||
define-function: (
|
||||
"check-warning",
|
||||
(theme, color, border_color, background_color),
|
||||
block {
|
||||
set-local-storage: {"rustdoc-theme": |theme|, "rustdoc-use-system-theme": "false"}
|
||||
reload:
|
||||
|
||||
// The IDs are added directly into the DOM to make writing this test easier.
|
||||
assert-css: ("#doc-warning-1", {
|
||||
"margin-bottom": "12px",
|
||||
"color": |color|,
|
||||
"border-left": "2px solid " + |border_color|,
|
||||
"background-color": |background_color|,
|
||||
})
|
||||
assert-css: ("#doc-warning-2", {
|
||||
"margin-bottom": "0px",
|
||||
"color": |color|,
|
||||
"border-left": "2px solid " + |border_color|,
|
||||
"background-color": |background_color|,
|
||||
})
|
||||
},
|
||||
)
|
||||
|
||||
call-function: ("check-warning", {
|
||||
"theme": "ayu",
|
||||
"color": "rgb(197, 197, 197)",
|
||||
"border_color": "rgb(255, 142, 0)",
|
||||
"background_color": "rgba(0, 0, 0, 0)",
|
||||
})
|
||||
call-function: ("check-warning", {
|
||||
"theme": "dark",
|
||||
"color": "rgb(221, 221, 221)",
|
||||
"border_color": "rgb(255, 142, 0)",
|
||||
"background_color": "rgba(0, 0, 0, 0)",
|
||||
})
|
||||
call-function: ("check-warning", {
|
||||
"theme": "light",
|
||||
"color": "rgb(0, 0, 0)",
|
||||
"border_color": "rgb(255, 142, 0)",
|
||||
"background_color": "rgba(0, 0, 0, 0)",
|
||||
})
|
Loading…
Add table
Add a link
Reference in a new issue