mirror of
https://github.com/rust-lang/rust.git
synced 2024-11-25 08:13:41 +00:00
rustdoc: rename CSS rustdoc-toggle -> toggle and toggle -> settings-toggle
This swaps things around so that the class that gets used more often has the shorter name.
This commit is contained in:
Michael Howell
parent
0b90256ada
commit
1d328de3ec
@ -513,7 +513,7 @@ fn document_full_inner(
|
||||
debug!("Doc block: =====\n{}\n=====", s);
|
||||
if is_collapsible {
|
||||
w.write_str(
|
||||
"<details class=\"rustdoc-toggle top-doc\" open>\
|
||||
"<details class=\"toggle top-doc\" open>\
|
||||
<summary class=\"hideme\">\
|
||||
<span>Expand description</span>\
|
||||
</summary>",
|
||||
@ -1514,7 +1514,7 @@ fn render_impl(
|
||||
let toggled = !doc_buffer.is_empty();
|
||||
if toggled {
|
||||
let method_toggle_class = if item_type.is_method() { " method-toggle" } else { "" };
|
||||
write!(w, "<details class=\"rustdoc-toggle{}\" open><summary>", method_toggle_class);
|
||||
write!(w, "<details class=\"toggle{}\" open><summary>", method_toggle_class);
|
||||
}
|
||||
match &*item.kind {
|
||||
clean::MethodItem(..) | clean::TyMethodItem(_) => {
|
||||
@ -1730,7 +1730,7 @@ fn render_impl(
|
||||
close_tags.insert_str(0, "</details>");
|
||||
write!(
|
||||
w,
|
||||
"<details class=\"rustdoc-toggle implementors-toggle\"{}>",
|
||||
"<details class=\"toggle implementors-toggle\"{}>",
|
||||
if rendering_params.toggle_open_by_default { " open" } else { "" }
|
||||
);
|
||||
write!(w, "<summary>")
|
||||
@ -2999,7 +2999,7 @@ fn render_call_locations(w: &mut Buffer, cx: &mut Context<'_>, item: &clean::Ite
|
||||
if it.peek().is_some() {
|
||||
write!(
|
||||
w,
|
||||
"<details class=\"rustdoc-toggle more-examples-toggle\">\
|
||||
"<details class=\"toggle more-examples-toggle\">\
|
||||
<summary class=\"hideme\">\
|
||||
<span>More examples</span>\
|
||||
</summary>\
|
||||
|
||||
@ -204,7 +204,7 @@ fn should_hide_fields(n_fields: usize) -> bool {
|
||||
fn toggle_open(w: &mut Buffer, text: impl fmt::Display) {
|
||||
write!(
|
||||
w,
|
||||
"<details class=\"rustdoc-toggle type-contents-toggle\">\
|
||||
"<details class=\"toggle type-contents-toggle\">\
|
||||
<summary class=\"hideme\">\
|
||||
<span>Show {}</span>\
|
||||
</summary>",
|
||||
@ -733,7 +733,7 @@ fn item_trait(w: &mut Buffer, cx: &mut Context<'_>, it: &clean::Item, t: &clean:
|
||||
let toggled = !content.is_empty();
|
||||
if toggled {
|
||||
let method_toggle_class = if item_type.is_method() { " method-toggle" } else { "" };
|
||||
write!(w, "<details class=\"rustdoc-toggle{method_toggle_class}\" open><summary>");
|
||||
write!(w, "<details class=\"toggle{method_toggle_class}\" open><summary>");
|
||||
}
|
||||
write!(w, "<section id=\"{}\" class=\"method has-srclink\">", id);
|
||||
render_rightside(w, cx, m, t, RenderMode::Normal);
|
||||
@ -1840,7 +1840,7 @@ fn document_non_exhaustive(w: &mut Buffer, item: &clean::Item) {
|
||||
if item.is_non_exhaustive() {
|
||||
write!(
|
||||
w,
|
||||
"<details class=\"rustdoc-toggle non-exhaustive\">\
|
||||
"<details class=\"toggle non-exhaustive\">\
|
||||
<summary class=\"hideme\"><span>{}</span></summary>\
|
||||
<div class=\"docblock\">",
|
||||
{
|
||||
|
||||
@ -317,7 +317,7 @@ main {
|
||||
margin-right: auto;
|
||||
}
|
||||
|
||||
details:not(.rustdoc-toggle) summary {
|
||||
details:not(.toggle) summary {
|
||||
margin-bottom: .6em;
|
||||
}
|
||||
|
||||
@ -1401,7 +1401,7 @@ details.dir-entry a {
|
||||
Unfortunately we can't yet specify contain: content or contain: strict
|
||||
because the [-]/[+] toggles extend past the boundaries of the <details>
|
||||
https://developer.mozilla.org/en-US/docs/Web/CSS/contain */
|
||||
details.rustdoc-toggle {
|
||||
details.toggle {
|
||||
contain: layout;
|
||||
position: relative;
|
||||
}
|
||||
@ -1409,26 +1409,26 @@ details.rustdoc-toggle {
|
||||
/* The hideme class is used on summary tags that contain a span with
|
||||
placeholder text shown only when the toggle is closed. For instance,
|
||||
"Expand description" or "Show methods". */
|
||||
details.rustdoc-toggle > summary.hideme {
|
||||
details.toggle > summary.hideme {
|
||||
cursor: pointer;
|
||||
font-size: 1rem;
|
||||
}
|
||||
|
||||
details.rustdoc-toggle > summary {
|
||||
details.toggle > summary {
|
||||
list-style: none;
|
||||
/* focus outline is shown on `::before` instead of this */
|
||||
outline: none;
|
||||
}
|
||||
details.rustdoc-toggle > summary::-webkit-details-marker,
|
||||
details.rustdoc-toggle > summary::marker {
|
||||
details.toggle > summary::-webkit-details-marker,
|
||||
details.toggle > summary::marker {
|
||||
display: none;
|
||||
}
|
||||
|
||||
details.rustdoc-toggle > summary.hideme > span {
|
||||
details.toggle > summary.hideme > span {
|
||||
margin-left: 9px;
|
||||
}
|
||||
|
||||
details.rustdoc-toggle > summary::before {
|
||||
details.toggle > summary::before {
|
||||
background: url("toggle-plus-1092eb4930d581b0.svg") no-repeat top left;
|
||||
content: "";
|
||||
cursor: pointer;
|
||||
@ -1440,14 +1440,14 @@ details.rustdoc-toggle > summary::before {
|
||||
filter: var(--toggle-filter);
|
||||
}
|
||||
|
||||
details.rustdoc-toggle > summary.hideme > span,
|
||||
details.toggle > summary.hideme > span,
|
||||
.more-examples-toggle summary, .more-examples-toggle .hide-more {
|
||||
color: var(--toggles-color);
|
||||
}
|
||||
|
||||
/* Screen readers see the text version at the end the line.
|
||||
Visual readers see the icon at the start of the line, but small and transparent. */
|
||||
details.rustdoc-toggle > summary::after {
|
||||
details.toggle > summary::after {
|
||||
content: "Expand";
|
||||
overflow: hidden;
|
||||
width: 0;
|
||||
@ -1455,17 +1455,17 @@ details.rustdoc-toggle > summary::after {
|
||||
position: absolute;
|
||||
}
|
||||
|
||||
details.rustdoc-toggle > summary.hideme::after {
|
||||
details.toggle > summary.hideme::after {
|
||||
/* "hideme" toggles already have a description when they're contracted */
|
||||
content: "";
|
||||
}
|
||||
|
||||
details.rustdoc-toggle > summary:focus::before,
|
||||
details.rustdoc-toggle > summary:hover::before {
|
||||
details.toggle > summary:focus::before,
|
||||
details.toggle > summary:hover::before {
|
||||
opacity: 1;
|
||||
}
|
||||
|
||||
details.rustdoc-toggle > summary:focus-visible::before {
|
||||
details.toggle > summary:focus-visible::before {
|
||||
/* The SVG is black, and gets turned white using a filter in the dark themes.
|
||||
Do the same with the outline.
|
||||
The dotted 1px style is copied from Firefox's focus ring style.
|
||||
@ -1478,17 +1478,17 @@ details.non-exhaustive {
|
||||
margin-bottom: 8px;
|
||||
}
|
||||
|
||||
details.rustdoc-toggle > summary.hideme::before {
|
||||
details.toggle > summary.hideme::before {
|
||||
position: relative;
|
||||
}
|
||||
|
||||
details.rustdoc-toggle > summary:not(.hideme)::before {
|
||||
details.toggle > summary:not(.hideme)::before {
|
||||
position: absolute;
|
||||
left: -24px;
|
||||
top: 4px;
|
||||
}
|
||||
|
||||
.impl-items > details.rustdoc-toggle > summary:not(.hideme)::before {
|
||||
.impl-items > details.toggle > summary:not(.hideme)::before {
|
||||
position: absolute;
|
||||
left: -24px;
|
||||
}
|
||||
@ -1498,19 +1498,19 @@ details.rustdoc-toggle > summary:not(.hideme)::before {
|
||||
affect the layout of the items to its right. To do that, we use
|
||||
absolute positioning. Note that we also set position: relative
|
||||
on the parent <details> to make this work properly. */
|
||||
details.rustdoc-toggle[open] > summary.hideme {
|
||||
details.toggle[open] > summary.hideme {
|
||||
position: absolute;
|
||||
}
|
||||
|
||||
details.rustdoc-toggle[open] > summary.hideme > span {
|
||||
details.toggle[open] > summary.hideme > span {
|
||||
display: none;
|
||||
}
|
||||
|
||||
details.rustdoc-toggle[open] > summary::before {
|
||||
details.toggle[open] > summary::before {
|
||||
background: url("toggle-minus-31bbd6e4c77f5c96.svg") no-repeat top left;
|
||||
}
|
||||
|
||||
details.rustdoc-toggle[open] > summary::after {
|
||||
details.toggle[open] > summary::after {
|
||||
content: "Collapse";
|
||||
}
|
||||
|
||||
@ -1660,8 +1660,8 @@ in storage.js
|
||||
display: block;
|
||||
}
|
||||
|
||||
#main-content > details.rustdoc-toggle > summary::before,
|
||||
#main-content > div > details.rustdoc-toggle > summary::before {
|
||||
#main-content > details.toggle > summary::before,
|
||||
#main-content > div > details.toggle > summary::before {
|
||||
left: -11px;
|
||||
}
|
||||
|
||||
@ -1715,12 +1715,12 @@ in storage.js
|
||||
}
|
||||
|
||||
/* Position of the "[-]" element. */
|
||||
details.rustdoc-toggle:not(.top-doc) > summary {
|
||||
details.toggle:not(.top-doc) > summary {
|
||||
margin-left: 10px;
|
||||
}
|
||||
.impl-items > details.rustdoc-toggle > summary:not(.hideme)::before,
|
||||
#main-content > details.rustdoc-toggle:not(.top-doc) > summary::before,
|
||||
#main-content > div > details.rustdoc-toggle > summary::before {
|
||||
.impl-items > details.toggle > summary:not(.hideme)::before,
|
||||
#main-content > details.toggle:not(.top-doc) > summary::before,
|
||||
#main-content > div > details.toggle > summary::before {
|
||||
left: -11px;
|
||||
}
|
||||
|
||||
@ -1753,8 +1753,8 @@ in storage.js
|
||||
|
||||
@media print {
|
||||
nav.sidebar, nav.sub, .out-of-band, a.srclink, #copy-path,
|
||||
details.rustdoc-toggle[open] > summary::before, details.rustdoc-toggle > summary::before,
|
||||
details.rustdoc-toggle.top-doc > summary {
|
||||
details.toggle[open] > summary::before, details.toggle > summary::before,
|
||||
details.toggle.top-doc > summary {
|
||||
display: none;
|
||||
}
|
||||
|
||||
@ -1796,24 +1796,24 @@ in storage.js
|
||||
.impl,
|
||||
#implementors-list > .docblock,
|
||||
.impl-items > section,
|
||||
.impl-items > .rustdoc-toggle > summary,
|
||||
.impl-items > .toggle > summary,
|
||||
.methods > section,
|
||||
.methods > .rustdoc-toggle > summary
|
||||
.methods > .toggle > summary
|
||||
{
|
||||
margin-bottom: 0.75em;
|
||||
}
|
||||
|
||||
.variants > .docblock,
|
||||
.implementors-toggle > .docblock,
|
||||
.impl-items > .rustdoc-toggle[open]:not(:last-child),
|
||||
.methods > .rustdoc-toggle[open]:not(:last-child),
|
||||
.impl-items > .toggle[open]:not(:last-child),
|
||||
.methods > .toggle[open]:not(:last-child),
|
||||
.implementors-toggle[open]:not(:last-child) {
|
||||
margin-bottom: 2em;
|
||||
}
|
||||
|
||||
#trait-implementations-list .impl-items > .rustdoc-toggle:not(:last-child),
|
||||
#synthetic-implementations-list .impl-items > .rustdoc-toggle:not(:last-child),
|
||||
#blanket-implementations-list .impl-items > .rustdoc-toggle:not(:last-child) {
|
||||
#trait-implementations-list .impl-items > .toggle:not(:last-child),
|
||||
#synthetic-implementations-list .impl-items > .toggle:not(:last-child),
|
||||
#blanket-implementations-list .impl-items > .toggle:not(:last-child) {
|
||||
margin-bottom: 1em;
|
||||
}
|
||||
|
||||
|
||||
@ -9,7 +9,7 @@
|
||||
}
|
||||
|
||||
.setting-line .radio-line input,
|
||||
.setting-line .toggle input {
|
||||
.setting-line .settings-toggle input {
|
||||
margin-right: 0.3em;
|
||||
height: 1.2rem;
|
||||
width: 1.2rem;
|
||||
@ -22,14 +22,14 @@
|
||||
.setting-line .radio-line input {
|
||||
border-radius: 50%;
|
||||
}
|
||||
.setting-line .toggle input:checked {
|
||||
.setting-line .settings-toggle input:checked {
|
||||
content: url('data:image/svg+xml,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 40 40">\
|
||||
<path d="M7,25L17,32L33,12" fill="none" stroke="black" stroke-width="5"/>\
|
||||
<path d="M7,23L17,30L33,10" fill="none" stroke="white" stroke-width="5"/></svg>');
|
||||
}
|
||||
|
||||
.setting-line .radio-line input + span,
|
||||
.setting-line .toggle span {
|
||||
.setting-line .settings-toggle span {
|
||||
padding-bottom: 1px;
|
||||
}
|
||||
|
||||
@ -50,7 +50,7 @@
|
||||
margin-left: 0.5em;
|
||||
}
|
||||
|
||||
.toggle {
|
||||
.settings-toggle {
|
||||
position: relative;
|
||||
width: 100%;
|
||||
margin-right: 20px;
|
||||
@ -67,11 +67,11 @@
|
||||
box-shadow: inset 0 0 0 3px var(--main-background-color);
|
||||
background-color: var(--settings-input-color);
|
||||
}
|
||||
.setting-line .toggle input:checked {
|
||||
.setting-line .settings-toggle input:checked {
|
||||
background-color: var(--settings-input-color);
|
||||
}
|
||||
.setting-line .radio-line input:focus,
|
||||
.setting-line .toggle input:focus {
|
||||
.setting-line .settings-toggle input:focus {
|
||||
box-shadow: 0 0 1px 1px var(--settings-input-color);
|
||||
}
|
||||
/* In here we combine both `:focus` and `:checked` properties. */
|
||||
@ -80,6 +80,6 @@
|
||||
0 0 2px 2px var(--settings-input-color);
|
||||
}
|
||||
.setting-line .radio-line input:hover,
|
||||
.setting-line .toggle input:hover {
|
||||
.setting-line .settings-toggle input:hover {
|
||||
border-color: var(--settings-input-color) !important;
|
||||
}
|
||||
|
||||
@ -620,7 +620,7 @@ function loadCss(cssUrl) {
|
||||
function expandAllDocs() {
|
||||
const innerToggle = document.getElementById(toggleAllDocsId);
|
||||
removeClass(innerToggle, "will-expand");
|
||||
onEachLazy(document.getElementsByClassName("rustdoc-toggle"), e => {
|
||||
onEachLazy(document.getElementsByClassName("toggle"), e => {
|
||||
if (!hasClass(e, "type-contents-toggle") && !hasClass(e, "more-examples-toggle")) {
|
||||
e.open = true;
|
||||
}
|
||||
@ -632,7 +632,7 @@ function loadCss(cssUrl) {
|
||||
function collapseAllDocs() {
|
||||
const innerToggle = document.getElementById(toggleAllDocsId);
|
||||
addClass(innerToggle, "will-expand");
|
||||
onEachLazy(document.getElementsByClassName("rustdoc-toggle"), e => {
|
||||
onEachLazy(document.getElementsByClassName("toggle"), e => {
|
||||
if (e.parentNode.id !== "implementations-list" ||
|
||||
(!hasClass(e, "implementors-toggle") &&
|
||||
!hasClass(e, "type-contents-toggle"))
|
||||
@ -680,7 +680,7 @@ function loadCss(cssUrl) {
|
||||
setImplementorsTogglesOpen("blanket-implementations-list", false);
|
||||
}
|
||||
|
||||
onEachLazy(document.getElementsByClassName("rustdoc-toggle"), e => {
|
||||
onEachLazy(document.getElementsByClassName("toggle"), e => {
|
||||
if (!hideLargeItemContents && hasClass(e, "type-contents-toggle")) {
|
||||
e.open = true;
|
||||
}
|
||||
@ -823,7 +823,7 @@ function loadCss(cssUrl) {
|
||||
});
|
||||
});
|
||||
|
||||
onEachLazy(document.querySelectorAll(".rustdoc-toggle > summary:not(.hideme)"), el => {
|
||||
onEachLazy(document.querySelectorAll(".toggle > summary:not(.hideme)"), el => {
|
||||
el.addEventListener("click", e => {
|
||||
if (e.target.tagName !== "SUMMARY" && e.target.tagName !== "A") {
|
||||
e.preventDefault();
|
||||
|
||||
@ -150,10 +150,10 @@
|
||||
});
|
||||
output += "</div></div>";
|
||||
} else {
|
||||
// This is a toggle.
|
||||
// This is a checkbox toggle.
|
||||
const checked = setting["default"] === true ? " checked" : "";
|
||||
output += `\
|
||||
<label class="toggle">\
|
||||
<label class="settings-toggle">\
|
||||
<input type="checkbox" id="${js_data_name}"${checked}>\
|
||||
<span class="label">${setting_name}</span>\
|
||||
</label>`;
|
||||
|
||||
@ -1,18 +1,18 @@
|
||||
// This test ensures that the margins on methods are coherent inside an impl block.
|
||||
goto: "file://" + |DOC_PATH| + "/test_docs/trait_members/struct.HasTrait.html#impl-TraitMembers-for-HasTrait"
|
||||
|
||||
assert-count: ("#trait-implementations-list > .rustdoc-toggle", 1)
|
||||
assert-count: ("#trait-implementations-list > .toggle", 1)
|
||||
|
||||
compare-elements-css: (
|
||||
// compare margin on type with margin on method
|
||||
"#trait-implementations-list .impl-items > .rustdoc-toggle:nth-child(1) > summary",
|
||||
"#trait-implementations-list .impl-items > .rustdoc-toggle:nth-child(2) > summary",
|
||||
"#trait-implementations-list .impl-items > .toggle:nth-child(1) > summary",
|
||||
"#trait-implementations-list .impl-items > .toggle:nth-child(2) > summary",
|
||||
["margin"]
|
||||
)
|
||||
|
||||
compare-elements-css: (
|
||||
// compare margin on type with margin on method
|
||||
"#trait-implementations-list .impl-items > .rustdoc-toggle:nth-child(1)",
|
||||
"#trait-implementations-list .impl-items > .rustdoc-toggle:nth-child(2)",
|
||||
"#trait-implementations-list .impl-items > .toggle:nth-child(1)",
|
||||
"#trait-implementations-list .impl-items > .toggle:nth-child(2)",
|
||||
["margin"]
|
||||
)
|
||||
|
||||
@ -159,7 +159,7 @@ assert-text: ("#preferred-light-theme .setting-name", "Preferred light theme")
|
||||
// We now check that clicking on the toggles' text is like clicking on the checkbox.
|
||||
// To test it, we use the "Disable keyboard shortcuts".
|
||||
local-storage: {"rustdoc-disable-shortcuts": "false"}
|
||||
click: ".setting-line:last-child .toggle .label"
|
||||
click: ".setting-line:last-child .settings-toggle .label"
|
||||
assert-local-storage: {"rustdoc-disable-shortcuts": "true"}
|
||||
|
||||
// Make sure that "Disable keyboard shortcuts" actually took effect.
|
||||
@ -169,7 +169,7 @@ assert-false: "#help-button .popover"
|
||||
wait-for-css: ("#settings-menu .popover", {"display": "block"})
|
||||
|
||||
// Now turn keyboard shortcuts back on, and see if they work.
|
||||
click: ".setting-line:last-child .toggle .label"
|
||||
click: ".setting-line:last-child .settings-toggle .label"
|
||||
assert-local-storage: {"rustdoc-disable-shortcuts": "false"}
|
||||
press-key: "Escape"
|
||||
press-key: "?"
|
||||
|
||||
@ -1,14 +1,14 @@
|
||||
// This test ensures that clicking on a method summary, but not on the "[-]",
|
||||
// doesn't toggle the <details>.
|
||||
goto: "file://" + |DOC_PATH| + "/lib2/struct.Foo.html"
|
||||
assert-attribute: (".impl-items .rustdoc-toggle", {"open": ""})
|
||||
assert-attribute: (".impl-items .toggle", {"open": ""})
|
||||
click: "h4.code-header" // This is the position of "pub" in "pub fn a_method"
|
||||
assert-attribute: (".impl-items .rustdoc-toggle", {"open": ""})
|
||||
assert-attribute: (".impl-items .toggle", {"open": ""})
|
||||
click-with-offset: (
|
||||
".impl-items .rustdoc-toggle summary",
|
||||
".impl-items .toggle summary",
|
||||
{"x": -24, "y": 8}, // This is the position of "[-]" next to that pub fn.
|
||||
)
|
||||
assert-attribute-false: (".impl-items .rustdoc-toggle", {"open": ""})
|
||||
assert-attribute-false: (".impl-items .toggle", {"open": ""})
|
||||
|
||||
// Click the "Trait" part of "impl Trait" and verify it navigates.
|
||||
click: "#impl-Trait-for-Foo h3 a:first-of-type"
|
||||
|
||||
@ -20,10 +20,10 @@ assert-text: ("#toggle-all-docs", "[−]")
|
||||
goto: "file://" + |DOC_PATH| + "/test_docs/struct.Foo.html"
|
||||
// We first check that everything is visible.
|
||||
assert-text: ("#toggle-all-docs", "[−]")
|
||||
assert-attribute: ("#implementations-list details.rustdoc-toggle", {"open": ""}, ALL)
|
||||
assert-attribute: ("#trait-implementations-list details.rustdoc-toggle", {"open": ""}, ALL)
|
||||
assert-attribute: ("#implementations-list details.toggle", {"open": ""}, ALL)
|
||||
assert-attribute: ("#trait-implementations-list details.toggle", {"open": ""}, ALL)
|
||||
assert-attribute-false: (
|
||||
"#blanket-implementations-list > details.rustdoc-toggle",
|
||||
"#blanket-implementations-list > details.toggle",
|
||||
{"open": ""},
|
||||
ALL,
|
||||
)
|
||||
@ -32,18 +32,18 @@ assert-attribute-false: (
|
||||
click: "#toggle-all-docs"
|
||||
wait-for-text: ("#toggle-all-docs", "[+]")
|
||||
// We check that all <details> are collapsed (except for the impl block ones).
|
||||
assert-attribute-false: ("details.rustdoc-toggle:not(.implementors-toggle)", {"open": ""}, ALL)
|
||||
assert-attribute-false: ("details.toggle:not(.implementors-toggle)", {"open": ""}, ALL)
|
||||
assert-attribute: ("#implementations-list > details.implementors-toggle", {"open": ""})
|
||||
// We now check that the other impl blocks are collapsed.
|
||||
assert-attribute-false: (
|
||||
"#blanket-implementations-list > details.rustdoc-toggle.implementors-toggle",
|
||||
"#blanket-implementations-list > details.toggle.implementors-toggle",
|
||||
{"open": ""},
|
||||
ALL,
|
||||
)
|
||||
// We open them all again.
|
||||
click: "#toggle-all-docs"
|
||||
wait-for-text: ("#toggle-all-docs", "[−]")
|
||||
assert-attribute: ("details.rustdoc-toggle", {"open": ""}, ALL)
|
||||
assert-attribute: ("details.toggle", {"open": ""}, ALL)
|
||||
|
||||
// Checking the toggles style.
|
||||
show-text: true
|
||||
@ -56,12 +56,12 @@ define-function: (
|
||||
// We reload the page so the local storage settings are being used.
|
||||
reload:
|
||||
|
||||
assert-css: ("details.rustdoc-toggle > summary::before", {
|
||||
assert-css: ("details.toggle > summary::before", {
|
||||
"opacity": "0.5",
|
||||
"filter": |filter|,
|
||||
}, ALL)
|
||||
move-cursor-to: "details.rustdoc-toggle summary"
|
||||
assert-css: ("details.rustdoc-toggle > summary:hover::before", {
|
||||
move-cursor-to: "details.toggle summary"
|
||||
assert-css: ("details.toggle > summary:hover::before", {
|
||||
"opacity": "1",
|
||||
"filter": |filter|,
|
||||
})
|
||||
|
||||
@ -2,4 +2,4 @@
|
||||
// has all the implementations toggled open by default, so users can
|
||||
// find method names in those implementations with Ctrl-F.
|
||||
goto: "file://" + |DOC_PATH| + "/test_docs/struct.Foo.html"
|
||||
assert-attribute: (".rustdoc-toggle.implementors-toggle", {"open": ""})
|
||||
assert-attribute: (".toggle.implementors-toggle", {"open": ""})
|
||||
|
||||
@ -5,7 +5,7 @@
|
||||
// @!hasraw - '<span class="attr">#[outer]</span>'
|
||||
// @hasraw - '#![inner]</span>'
|
||||
// @!hasraw - '<span class="attr">#![inner]</span>'
|
||||
// @snapshot 'codeblock' - '//*[@class="rustdoc-toggle top-doc"]/*[@class="docblock"]//pre/code'
|
||||
// @snapshot 'codeblock' - '//*[@class="toggle top-doc"]/*[@class="docblock"]//pre/code'
|
||||
|
||||
/// ```no_run
|
||||
/// # # space
|
||||
|
||||
@ -4,7 +4,7 @@
|
||||
#![crate_name = "foo"]
|
||||
|
||||
// @has 'foo/fn.g.html'
|
||||
// @has - '//*[@class="rustdoc-toggle top-doc"]/*[@class="docblock"]' \
|
||||
// @has - '//*[@class="toggle top-doc"]/*[@class="docblock"]' \
|
||||
// 'outer module inner module'
|
||||
|
||||
mod inner_mod {
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
#![crate_name = "foo"]
|
||||
|
||||
// @has 'foo/struct.S1.html'
|
||||
// @snapshot S1_top-doc - '//details[@class="rustdoc-toggle top-doc"]/div[@class="docblock"]'
|
||||
// @snapshot S1_top-doc - '//details[@class="toggle top-doc"]/div[@class="docblock"]'
|
||||
|
||||
#[doc = "Hello world!\n\n"]
|
||||
/// Goodbye!
|
||||
@ -9,7 +9,7 @@
|
||||
pub struct S1;
|
||||
|
||||
// @has 'foo/struct.S2.html'
|
||||
// @snapshot S2_top-doc - '//details[@class="rustdoc-toggle top-doc"]/div[@class="docblock"]'
|
||||
// @snapshot S2_top-doc - '//details[@class="toggle top-doc"]/div[@class="docblock"]'
|
||||
|
||||
/// Hello world!
|
||||
///
|
||||
@ -18,7 +18,7 @@ pub struct S1;
|
||||
pub struct S2;
|
||||
|
||||
// @has 'foo/struct.S3.html'
|
||||
// @snapshot S3_top-doc - '//details[@class="rustdoc-toggle top-doc"]/div[@class="docblock"]'
|
||||
// @snapshot S3_top-doc - '//details[@class="toggle top-doc"]/div[@class="docblock"]'
|
||||
/** Par 1
|
||||
*/ ///
|
||||
/// Par 2
|
||||
|
||||
@ -21,14 +21,14 @@ mod c {
|
||||
}
|
||||
|
||||
// @has 'foo/struct.Type.html'
|
||||
// @has - '//*[@class="rustdoc-toggle top-doc"]/*[@class="docblock"]' 'foo 2 1'
|
||||
// @has - '//*[@class="toggle top-doc"]/*[@class="docblock"]' 'foo 2 1'
|
||||
/// foo
|
||||
pub use b::Type;
|
||||
// @has 'foo/struct.Whatever.html'
|
||||
// @has - '//*[@class="rustdoc-toggle top-doc"]/*[@class="docblock"]' 'whatever 3 2 1'
|
||||
// @has - '//*[@class="toggle top-doc"]/*[@class="docblock"]' 'whatever 3 2 1'
|
||||
/// whatever
|
||||
pub use c::Type as Whatever;
|
||||
// @has 'foo/struct.Woof.html'
|
||||
// @has - '//*[@class="rustdoc-toggle top-doc"]/*[@class="docblock"]' 'a dog 4 2 1'
|
||||
// @has - '//*[@class="toggle top-doc"]/*[@class="docblock"]' 'a dog 4 2 1'
|
||||
/// a dog
|
||||
pub use c::Woof;
|
||||
|
||||
@ -4,7 +4,7 @@
|
||||
// block doc comments can have their lines starting with a star.
|
||||
|
||||
// @has foo/fn.foo.html
|
||||
// @snapshot docblock - '//*[@class="rustdoc-toggle top-doc"]//*[@class="docblock"]'
|
||||
// @snapshot docblock - '//*[@class="toggle top-doc"]//*[@class="docblock"]'
|
||||
/**
|
||||
* a
|
||||
*/
|
||||
|
||||
@ -1,15 +1,15 @@
|
||||
#![allow(unused)]
|
||||
|
||||
// @has 'toggle_item_contents/struct.PubStruct.html'
|
||||
// @count - '//details[@class="rustdoc-toggle type-contents-toggle"]' 0
|
||||
// @count - '//details[@class="toggle type-contents-toggle"]' 0
|
||||
pub struct PubStruct {
|
||||
pub a: usize,
|
||||
pub b: usize,
|
||||
}
|
||||
|
||||
// @has 'toggle_item_contents/struct.BigPubStruct.html'
|
||||
// @count - '//details[@class="rustdoc-toggle type-contents-toggle"]' 1
|
||||
// @has - '//details[@class="rustdoc-toggle type-contents-toggle"]' 'Show 13 fields'
|
||||
// @count - '//details[@class="toggle type-contents-toggle"]' 1
|
||||
// @has - '//details[@class="toggle type-contents-toggle"]' 'Show 13 fields'
|
||||
pub struct BigPubStruct {
|
||||
pub a: usize,
|
||||
pub b: usize,
|
||||
@ -27,8 +27,8 @@ pub struct BigPubStruct {
|
||||
}
|
||||
|
||||
// @has 'toggle_item_contents/union.BigUnion.html'
|
||||
// @count - '//details[@class="rustdoc-toggle type-contents-toggle"]' 1
|
||||
// @has - '//details[@class="rustdoc-toggle type-contents-toggle"]' 'Show 13 fields'
|
||||
// @count - '//details[@class="toggle type-contents-toggle"]' 1
|
||||
// @has - '//details[@class="toggle type-contents-toggle"]' 'Show 13 fields'
|
||||
pub union BigUnion {
|
||||
pub a: usize,
|
||||
pub b: usize,
|
||||
@ -46,7 +46,7 @@ pub union BigUnion {
|
||||
}
|
||||
|
||||
// @has 'toggle_item_contents/union.Union.html'
|
||||
// @count - '//details[@class="rustdoc-toggle type-contents-toggle"]' 0
|
||||
// @count - '//details[@class="toggle type-contents-toggle"]' 0
|
||||
pub union Union {
|
||||
pub a: usize,
|
||||
pub b: usize,
|
||||
@ -54,7 +54,7 @@ pub union Union {
|
||||
}
|
||||
|
||||
// @has 'toggle_item_contents/struct.PrivStruct.html'
|
||||
// @count - '//details[@class="rustdoc-toggle type-contents-toggle"]' 0
|
||||
// @count - '//details[@class="toggle type-contents-toggle"]' 0
|
||||
// @has - '//div[@class="item-decl"]' '/* private fields */'
|
||||
pub struct PrivStruct {
|
||||
a: usize,
|
||||
@ -62,7 +62,7 @@ pub struct PrivStruct {
|
||||
}
|
||||
|
||||
// @has 'toggle_item_contents/enum.Enum.html'
|
||||
// @!has - '//details[@class="rustdoc-toggle type-contents-toggle"]' ''
|
||||
// @!has - '//details[@class="toggle type-contents-toggle"]' ''
|
||||
pub enum Enum {
|
||||
A, B, C,
|
||||
D {
|
||||
@ -72,7 +72,7 @@ pub enum Enum {
|
||||
}
|
||||
|
||||
// @has 'toggle_item_contents/enum.EnumStructVariant.html'
|
||||
// @!has - '//details[@class="rustdoc-toggle type-contents-toggle"]' ''
|
||||
// @!has - '//details[@class="toggle type-contents-toggle"]' ''
|
||||
pub enum EnumStructVariant {
|
||||
A, B, C,
|
||||
D {
|
||||
@ -81,14 +81,14 @@ pub enum EnumStructVariant {
|
||||
}
|
||||
|
||||
// @has 'toggle_item_contents/enum.LargeEnum.html'
|
||||
// @count - '//*[@class="rust enum"]//details[@class="rustdoc-toggle type-contents-toggle"]' 1
|
||||
// @has - '//*[@class="rust enum"]//details[@class="rustdoc-toggle type-contents-toggle"]' 'Show 13 variants'
|
||||
// @count - '//*[@class="rust enum"]//details[@class="toggle type-contents-toggle"]' 1
|
||||
// @has - '//*[@class="rust enum"]//details[@class="toggle type-contents-toggle"]' 'Show 13 variants'
|
||||
pub enum LargeEnum {
|
||||
A, B, C, D, E, F(u8), G, H, I, J, K, L, M
|
||||
}
|
||||
|
||||
// @has 'toggle_item_contents/trait.Trait.html'
|
||||
// @count - '//details[@class="rustdoc-toggle type-contents-toggle"]' 0
|
||||
// @count - '//details[@class="toggle type-contents-toggle"]' 0
|
||||
pub trait Trait {
|
||||
type A;
|
||||
#[must_use]
|
||||
@ -97,8 +97,8 @@ pub trait Trait {
|
||||
}
|
||||
|
||||
// @has 'toggle_item_contents/trait.GinormousTrait.html'
|
||||
// @count - '//details[@class="rustdoc-toggle type-contents-toggle"]' 1
|
||||
// @has - '//details[@class="rustdoc-toggle type-contents-toggle"]' 'Show 16 associated items'
|
||||
// @count - '//details[@class="toggle type-contents-toggle"]' 1
|
||||
// @has - '//details[@class="toggle type-contents-toggle"]' 'Show 16 associated items'
|
||||
pub trait GinormousTrait {
|
||||
type A;
|
||||
type B;
|
||||
@ -120,8 +120,8 @@ pub trait GinormousTrait {
|
||||
}
|
||||
|
||||
// @has 'toggle_item_contents/trait.HugeTrait.html'
|
||||
// @count - '//details[@class="rustdoc-toggle type-contents-toggle"]' 1
|
||||
// @has - '//details[@class="rustdoc-toggle type-contents-toggle"]' 'Show 12 associated constants and 2 methods'
|
||||
// @count - '//details[@class="toggle type-contents-toggle"]' 1
|
||||
// @has - '//details[@class="toggle type-contents-toggle"]' 'Show 12 associated constants and 2 methods'
|
||||
pub trait HugeTrait {
|
||||
type A;
|
||||
const M: usize = 1;
|
||||
@ -142,8 +142,8 @@ pub trait HugeTrait {
|
||||
}
|
||||
|
||||
// @has 'toggle_item_contents/trait.GiganticTrait.html'
|
||||
// @count - '//details[@class="rustdoc-toggle type-contents-toggle"]' 1
|
||||
// @has - '//details[@class="rustdoc-toggle type-contents-toggle"]' 'Show 1 associated constant and 1 method'
|
||||
// @count - '//details[@class="toggle type-contents-toggle"]' 1
|
||||
// @has - '//details[@class="toggle type-contents-toggle"]' 'Show 1 associated constant and 1 method'
|
||||
pub trait GiganticTrait {
|
||||
type A;
|
||||
type B;
|
||||
@ -163,8 +163,8 @@ pub trait GiganticTrait {
|
||||
}
|
||||
|
||||
// @has 'toggle_item_contents/trait.BigTrait.html'
|
||||
// @count - '//details[@class="rustdoc-toggle type-contents-toggle"]' 1
|
||||
// @has - '//details[@class="rustdoc-toggle type-contents-toggle"]' 'Show 14 methods'
|
||||
// @count - '//details[@class="toggle type-contents-toggle"]' 1
|
||||
// @has - '//details[@class="toggle type-contents-toggle"]' 'Show 14 methods'
|
||||
pub trait BigTrait {
|
||||
type A;
|
||||
#[must_use]
|
||||
|
||||
@ -4,9 +4,9 @@
|
||||
// summary. Struct methods with no documentation should not be wrapped.
|
||||
//
|
||||
// @has foo/struct.Foo.html
|
||||
// @has - '//details[@class="rustdoc-toggle method-toggle"]//summary//h4[@class="code-header"]' 'is_documented()'
|
||||
// @has - '//details[@class="rustdoc-toggle method-toggle"]//*[@class="docblock"]' 'is_documented is documented'
|
||||
// @!has - '//details[@class="rustdoc-toggle method-toggle"]//summary//h4[@class="code-header"]' 'not_documented()'
|
||||
// @has - '//details[@class="toggle method-toggle"]//summary//h4[@class="code-header"]' 'is_documented()'
|
||||
// @has - '//details[@class="toggle method-toggle"]//*[@class="docblock"]' 'is_documented is documented'
|
||||
// @!has - '//details[@class="toggle method-toggle"]//summary//h4[@class="code-header"]' 'not_documented()'
|
||||
pub struct Foo {
|
||||
}
|
||||
|
||||
|
||||
@ -4,14 +4,14 @@
|
||||
// summary. Trait methods with no documentation should not be wrapped.
|
||||
//
|
||||
// @has foo/trait.Foo.html
|
||||
// @has - '//details[@class="rustdoc-toggle"]//summary//h4[@class="code-header"]' 'type Item'
|
||||
// @!has - '//details[@class="rustdoc-toggle"]//summary//h4[@class="code-header"]' 'type Item2'
|
||||
// @has - '//details[@class="rustdoc-toggle method-toggle"]//summary//h4[@class="code-header"]' 'is_documented()'
|
||||
// @!has - '//details[@class="rustdoc-toggle method-toggle"]//summary//h4[@class="code-header"]' 'not_documented()'
|
||||
// @has - '//details[@class="rustdoc-toggle method-toggle"]//*[@class="docblock"]' 'is_documented is documented'
|
||||
// @has - '//details[@class="rustdoc-toggle method-toggle"]//summary//h4[@class="code-header"]' 'is_documented_optional()'
|
||||
// @!has - '//details[@class="rustdoc-toggle method-toggle"]//summary//h4[@class="code-header"]' 'not_documented_optional()'
|
||||
// @has - '//details[@class="rustdoc-toggle method-toggle"]//*[@class="docblock"]' 'is_documented_optional is documented'
|
||||
// @has - '//details[@class="toggle"]//summary//h4[@class="code-header"]' 'type Item'
|
||||
// @!has - '//details[@class="toggle"]//summary//h4[@class="code-header"]' 'type Item2'
|
||||
// @has - '//details[@class="toggle method-toggle"]//summary//h4[@class="code-header"]' 'is_documented()'
|
||||
// @!has - '//details[@class="toggle method-toggle"]//summary//h4[@class="code-header"]' 'not_documented()'
|
||||
// @has - '//details[@class="toggle method-toggle"]//*[@class="docblock"]' 'is_documented is documented'
|
||||
// @has - '//details[@class="toggle method-toggle"]//summary//h4[@class="code-header"]' 'is_documented_optional()'
|
||||
// @!has - '//details[@class="toggle method-toggle"]//summary//h4[@class="code-header"]' 'not_documented_optional()'
|
||||
// @has - '//details[@class="toggle method-toggle"]//*[@class="docblock"]' 'is_documented_optional is documented'
|
||||
pub trait Foo {
|
||||
/// is documented
|
||||
type Item;
|
||||
|
||||
Loading…
Reference in New Issue
Block a user