From 569384b99a1127e57c7c52c4ee7c5cdb2d5e8b8c Mon Sep 17 00:00:00 2001 From: Michael Howell Date: Fri, 30 Sep 2022 13:32:33 -0700 Subject: [PATCH 1/2] rustdoc: remove weird `` wrapper around unsafe triangle This DOM cleanup changes the color of the triangle, from blue to black, but since it's still a different color from the link it's next to, it should still be noticeable. --- src/librustdoc/html/render/print_item.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/librustdoc/html/render/print_item.rs b/src/librustdoc/html/render/print_item.rs index 7999373511b..6327817364a 100644 --- a/src/librustdoc/html/render/print_item.rs +++ b/src/librustdoc/html/render/print_item.rs @@ -400,7 +400,7 @@ fn item_module(w: &mut Buffer, cx: &mut Context<'_>, item: &clean::Item, items: if myitem.fn_header(cx.tcx()).unwrap().unsafety == hir::Unsafety::Unsafe => { - "⚠" + "⚠" } _ => "", }; From bf510b4deddf99d9321d86754c18d2a143233b11 Mon Sep 17 00:00:00 2001 From: Michael Howell Date: Sat, 8 Oct 2022 09:36:37 -0700 Subject: [PATCH 2/2] rustdoc: add test case for dimensions and color of unsafe `` --- src/test/rustdoc-gui/src/test_docs/lib.rs | 4 +++ src/test/rustdoc-gui/unsafe-fn.goml | 37 +++++++++++++++++++++++ 2 files changed, 41 insertions(+) create mode 100644 src/test/rustdoc-gui/unsafe-fn.goml diff --git a/src/test/rustdoc-gui/src/test_docs/lib.rs b/src/test/rustdoc-gui/src/test_docs/lib.rs index 0281973c1ba..33c74e3a331 100644 --- a/src/test/rustdoc-gui/src/test_docs/lib.rs +++ b/src/test/rustdoc-gui/src/test_docs/lib.rs @@ -367,3 +367,7 @@ impl TypeWithNoDocblocks { pub fn first_fn(&self) {} pub fn second_fn(&self) {} } + +pub unsafe fn unsafe_fn() {} + +pub fn safe_fn() {} diff --git a/src/test/rustdoc-gui/unsafe-fn.goml b/src/test/rustdoc-gui/unsafe-fn.goml new file mode 100644 index 00000000000..94f128db72e --- /dev/null +++ b/src/test/rustdoc-gui/unsafe-fn.goml @@ -0,0 +1,37 @@ +goto: "file://" + |DOC_PATH| + "/test_docs/index.html" + +compare-elements-property: ( + "//a[@title='test_docs::safe_fn fn']/..", + "//a[@title='test_docs::unsafe_fn fn']/..", + ["clientHeight"] +) + +// If the text isn't displayed, the browser doesn't compute color style correctly... +show-text: true + +// Set the theme to dark. +local-storage: {"rustdoc-theme": "dark", "rustdoc-preferred-dark-theme": "dark", "rustdoc-use-system-theme": "false"} +// We reload the page so the local storage settings are being used. +reload: + +assert-css: (".item-left sup", { + "color": "rgb(221, 221, 221)" +}) + +// Set the theme to ayu. +local-storage: {"rustdoc-theme": "ayu", "rustdoc-preferred-dark-theme": "ayu", "rustdoc-use-system-theme": "false"} +// We reload the page so the local storage settings are being used. +reload: + +assert-css: (".item-left sup", { + "color": "rgb(197, 197, 197)" +}) + +// Set the theme to light. +local-storage: {"rustdoc-theme": "light", "rustdoc-preferred-dark-theme": "light", "rustdoc-use-system-theme": "false"} +// We reload the page so the local storage settings are being used. +reload: + +assert-css: (".item-left sup", { + "color": "rgb(0, 0, 0)" +})