rustdoc: give .line-number / .line-numbers meaningful names

notriddle · notriddle · commit 0b97831af756 · 2022-09-26T11:48:03.000-07:00
diff --git a/src/librustdoc/html/sources.rs b/src/librustdoc/html/sources.rs
@@ -274,7 +274,7 @@ pub(crate) fn print_src(
 ) {
     let lines = s.lines().count();
     let mut line_numbers = Buffer::empty_from(buf);
-    line_numbers.write_str("<pre class=\"line-numbers\">");
+    line_numbers.write_str("<pre class=\"src-line-numbers\">");
     match source_context {
         SourceContext::Standalone => {
             for line in 1..=lines {
diff --git a/src/librustdoc/html/static/css/rustdoc.css b/src/librustdoc/html/static/css/rustdoc.css
@@ -578,7 +578,7 @@ h2.location a {
 	position: relative;
 }
 
-.example-wrap > pre.line-number {
+.example-wrap > pre.example-line-numbers {
 	overflow: initial;
 	border: 1px solid;
 	padding: 13px 8px;
@@ -591,15 +591,15 @@ h2.location a {
 	text-decoration: underline;
 }
 
-.line-numbers {
+.src-line-numbers {
 	text-align: right;
 }
-.rustdoc:not(.source) .example-wrap > pre:not(.line-number) {
+.rustdoc:not(.source) .example-wrap > pre:not(.example-line-numbers) {
 	width: 100%;
 	overflow-x: auto;
 }
 
-.rustdoc:not(.source) .example-wrap > pre.line-numbers {
+.rustdoc:not(.source) .example-wrap > pre.src-line-numbers {
 	width: auto;
 	overflow-x: visible;
 }
@@ -612,14 +612,14 @@ h2.location a {
 	text-align: center;
 }
 
-.content > .example-wrap pre.line-numbers {
+.content > .example-wrap pre.src-line-numbers {
 	position: relative;
 	-webkit-user-select: none;
 	-moz-user-select: none;
 	-ms-user-select: none;
 	user-select: none;
 }
-.line-numbers span {
+.src-line-numbers span {
 	cursor: pointer;
 }
 
@@ -2067,7 +2067,7 @@ in storage.js plus the media query with (min-width: 701px)
 	padding-bottom: 0;
 }
 
-.scraped-example:not(.expanded) .code-wrapper pre.line-numbers {
+.scraped-example:not(.expanded) .code-wrapper pre.src-line-numbers {
 	overflow-x: hidden;
 }
 
@@ -2113,12 +2113,12 @@ in storage.js plus the media query with (min-width: 701px)
 	bottom: 0;
 }
 
-.scraped-example .code-wrapper .line-numbers {
+.scraped-example .code-wrapper .src-line-numbers {
 	margin: 0;
 	padding: 14px 0;
 }
 
-.scraped-example .code-wrapper .line-numbers span {
+.scraped-example .code-wrapper .src-line-numbers span {
 	padding: 0 14px;
 }
 
diff --git a/src/librustdoc/html/static/css/themes/ayu.css b/src/librustdoc/html/static/css/themes/ayu.css
@@ -93,8 +93,8 @@ pre, .rustdoc.source .example-wrap {
 	color: #ff7733;
 }
 
-.line-numbers span { color: #5c6773; }
-.line-numbers .line-highlighted {
+.src-line-numbers span { color: #5c6773; }
+.src-line-numbers .line-highlighted {
 	color: #708090;
 	background-color: rgba(255, 236, 164, 0.06);
 	padding-right: 4px;
@@ -171,7 +171,7 @@ details.rustdoc-toggle > summary::before {
 	color: #788797;
 }
 
-.line-numbers :target { background-color: transparent; }
+.src-line-numbers :target { background-color: transparent; }
 
 /* Code highlighting */
 pre.rust .number, pre.rust .string { color: #b8cc52; }
@@ -190,7 +190,7 @@ pre.rust .attribute {
 	color: #e6e1cf;
 }
 
-.example-wrap > pre.line-number {
+.example-wrap > pre.example-line-numbers {
 	color: #5c67736e;
 	border: none;
 }
diff --git a/src/librustdoc/html/static/css/themes/dark.css b/src/librustdoc/html/static/css/themes/dark.css
@@ -54,8 +54,8 @@ input:focus + .slider {
 	background: #444;
 }
 
-.line-numbers span { color: #3B91E2; }
-.line-numbers .line-highlighted {
+.src-line-numbers span { color: #3B91E2; }
+.src-line-numbers .line-highlighted {
 	background-color: #0a042f !important;
 }
 
@@ -141,7 +141,7 @@ details.rustdoc-toggle > summary::before {
 	background: none;
 }
 
-.line-numbers :target { background-color: transparent; }
+.src-line-numbers :target { background-color: transparent; }
 
 /* Code highlighting */
 pre.rust .kw { color: #ab8ac1; }
@@ -155,7 +155,7 @@ pre.rust .question-mark {
 	color: #ff9011;
 }
 
-.example-wrap > pre.line-number {
+.example-wrap > pre.example-line-numbers {
 	border-color: #4a4949;
 }
 
diff --git a/src/librustdoc/html/static/css/themes/light.css b/src/librustdoc/html/static/css/themes/light.css
@@ -53,8 +53,8 @@ input:focus + .slider {
 	background-color: #fff;
 }
 
-.line-numbers span { color: #c67e2d; }
-.line-numbers .line-highlighted {
+.src-line-numbers span { color: #c67e2d; }
+.src-line-numbers .line-highlighted {
 	background-color: #FDFFD3 !important;
 }
 
@@ -125,7 +125,7 @@ body.source .example-wrap pre.rust a {
 .stab { background: #FFF5D6; border-color: #FFC600; }
 .stab.portability > code { background: none; }
 
-.line-numbers :target { background-color: transparent; }
+.src-line-numbers :target { background-color: transparent; }
 
 /* Code highlighting */
 pre.rust .kw { color: #8959A8; }
@@ -141,7 +141,7 @@ pre.rust .question-mark {
 	color: #ff9011;
 }
 
-.example-wrap > pre.line-number {
+.example-wrap > pre.example-line-numbers {
 	border-color: #c7c7c7;
 }
 
diff --git a/src/librustdoc/html/static/js/main.js b/src/librustdoc/html/static/js/main.js
@@ -699,7 +699,7 @@ function loadCss(cssFileName) {
     window.rustdoc_add_line_numbers_to_examples = () => {
         onEachLazy(document.getElementsByClassName("rust-example-rendered"), x => {
             const parent = x.parentNode;
-            const line_numbers = parent.querySelectorAll(".line-number");
+            const line_numbers = parent.querySelectorAll(".example-line-numbers");
             if (line_numbers.length > 0) {
                 return;
             }
@@ -709,7 +709,7 @@ function loadCss(cssFileName) {
                 elems.push(i + 1);
             }
             const node = document.createElement("pre");
-            addClass(node, "line-number");
+            addClass(node, "example-line-numbers");
             node.innerHTML = elems.join("\n");
             parent.insertBefore(node, x);
         });
@@ -718,7 +718,7 @@ function loadCss(cssFileName) {
     window.rustdoc_remove_line_numbers_from_examples = () => {
         onEachLazy(document.getElementsByClassName("rust-example-rendered"), x => {
             const parent = x.parentNode;
-            const line_numbers = parent.querySelectorAll(".line-number");
+            const line_numbers = parent.querySelectorAll(".example-line-numbers");
             for (const node of line_numbers) {
                 parent.removeChild(node);
             }
diff --git a/src/librustdoc/html/static/js/scrape-examples.js b/src/librustdoc/html/static/js/scrape-examples.js
@@ -8,7 +8,7 @@
 
     // Scroll code block to the given code location
     function scrollToLoc(elt, loc) {
-        const lines = elt.querySelector(".line-numbers");
+        const lines = elt.querySelector(".src-line-numbers");
         let scrollOffset;
 
         // If the block is greater than the size of the viewer,
diff --git a/src/librustdoc/html/static/js/source-script.js b/src/librustdoc/html/static/js/source-script.js
@@ -183,7 +183,7 @@ function highlightSourceLines(match) {
     if (x) {
         x.scrollIntoView();
     }
-    onEachLazy(document.getElementsByClassName("line-numbers"), e => {
+    onEachLazy(document.getElementsByClassName("src-line-numbers"), e => {
         onEachLazy(e.getElementsByTagName("span"), i_e => {
             removeClass(i_e, "line-highlighted");
         });
@@ -245,7 +245,7 @@ window.addEventListener("hashchange", () => {
     }
 });
 
-onEachLazy(document.getElementsByClassName("line-numbers"), el => {
+onEachLazy(document.getElementsByClassName("src-line-numbers"), el => {
     el.addEventListener("click", handleSourceHighlight);
 });
 
diff --git a/src/test/run-make-fulldeps/rustdoc-scrape-examples-macros/src/lib.rs b/src/test/run-make-fulldeps/rustdoc-scrape-examples-macros/src/lib.rs
@@ -1,8 +1,8 @@
 // Scraped example should only include line numbers for items b and c in ex.rs
-// @!has foobar/fn.f.html '//*[@class="line-numbers"]' '14'
-// @has foobar/fn.f.html '//*[@class="line-numbers"]' '15'
-// @has foobar/fn.f.html '//*[@class="line-numbers"]' '21'
-// @!has foobar/fn.f.html '//*[@class="line-numbers"]' '22'
+// @!has foobar/fn.f.html '//*[@class="src-line-numbers"]' '14'
+// @has foobar/fn.f.html '//*[@class="src-line-numbers"]' '15'
+// @has foobar/fn.f.html '//*[@class="src-line-numbers"]' '21'
+// @!has foobar/fn.f.html '//*[@class="src-line-numbers"]' '22'
 
 pub fn f() {}
 
diff --git a/src/test/rustdoc-gui/basic-code.goml b/src/test/rustdoc-gui/basic-code.goml
@@ -1,3 +1,3 @@
 goto: file://|DOC_PATH|/test_docs/index.html
 click: ".srclink"
-assert-count: (".line-numbers", 1)
+assert-count: (".src-line-numbers", 1)
diff --git a/src/test/rustdoc-gui/docblock-code-block-line-number.goml b/src/test/rustdoc-gui/docblock-code-block-line-number.goml
@@ -2,24 +2,24 @@
 goto: file://|DOC_PATH|/test_docs/fn.foo.html
 
 // We check that without this setting, there is no line number displayed.
-assert-false: "pre.line-number"
+assert-false: "pre.example-line-numbers"
 
 // We now set the setting to show the line numbers on code examples.
 local-storage: {"rustdoc-line-numbers": "true" }
 // We reload to make the line numbers appear.
 reload:
 
 // We wait for them to be added into the DOM by the JS...
-wait-for: "pre.line-number"
+wait-for: "pre.example-line-numbers"
 // If the test didn't fail, it means that it was found!
 // Let's now check some CSS properties...
-assert-css: ("pre.line-number", {
+assert-css: ("pre.example-line-numbers", {
     "margin": "0px",
     "padding": "13px 8px",
     "text-align": "right",
 })
 // The first code block has two lines so let's check its `<pre>` elements lists both of them.
-assert-text: ("pre.line-number", "1\n2")
+assert-text: ("pre.example-line-numbers", "1\n2")
 
 // Now, try changing the setting dynamically. We'll turn it off, using the settings menu,
 // and make sure it goes away.
@@ -32,8 +32,8 @@ assert-css: ("#settings", {"display": "block"})
 // Then, click the toggle button.
 click: "input#line-numbers + .slider"
 wait-for: 100 // wait-for-false does not exist
-assert-false: "pre.line-number"
+assert-false: "pre.example-line-numbers"
 
 // Finally, turn it on again.
 click: "input#line-numbers + .slider"
-wait-for: "pre.line-number"
+wait-for: "pre.example-line-numbers"
diff --git a/src/test/rustdoc-gui/source-code-page.goml b/src/test/rustdoc-gui/source-code-page.goml
@@ -1,30 +1,30 @@
 // Checks that the interactions with the source code pages are working as expected.
 goto: file://|DOC_PATH|/src/test_docs/lib.rs.html
 // Check that we can click on the line number.
-click: ".line-numbers > span:nth-child(4)" // This is the span for line 4.
+click: ".src-line-numbers > span:nth-child(4)" // This is the span for line 4.
 // Ensure that the page URL was updated.
 assert-document-property: ({"URL": "lib.rs.html#4"}, ENDS_WITH)
 assert-attribute: ("//*[@id='4']", {"class": "line-highlighted"})
 // We now check that the good spans are highlighted
 goto: file://|DOC_PATH|/src/test_docs/lib.rs.html#4-6
-assert-attribute-false: (".line-numbers > span:nth-child(3)", {"class": "line-highlighted"})
-assert-attribute: (".line-numbers > span:nth-child(4)", {"class": "line-highlighted"})
-assert-attribute: (".line-numbers > span:nth-child(5)", {"class": "line-highlighted"})
-assert-attribute: (".line-numbers > span:nth-child(6)", {"class": "line-highlighted"})
-assert-attribute-false: (".line-numbers > span:nth-child(7)", {"class": "line-highlighted"})
+assert-attribute-false: (".src-line-numbers > span:nth-child(3)", {"class": "line-highlighted"})
+assert-attribute: (".src-line-numbers > span:nth-child(4)", {"class": "line-highlighted"})
+assert-attribute: (".src-line-numbers > span:nth-child(5)", {"class": "line-highlighted"})
+assert-attribute: (".src-line-numbers > span:nth-child(6)", {"class": "line-highlighted"})
+assert-attribute-false: (".src-line-numbers > span:nth-child(7)", {"class": "line-highlighted"})
 // This is to ensure that the content is correctly align with the line numbers.
 compare-elements-position: ("//*[@id='1']", ".rust > code > span", ("y"))
 
 // Assert that the line numbers text is aligned to the right.
-assert-css: (".line-numbers", {"text-align": "right"})
+assert-css: (".src-line-numbers", {"text-align": "right"})
 
 // Now let's check that clicking on something else than the line number doesn't
 // do anything (and certainly not add a `#NaN` to the URL!).
 show-text: true
 goto: file://|DOC_PATH|/src/test_docs/lib.rs.html
 // We use this assert-position to know where we will click.
 assert-position: ("//*[@id='1']", {"x": 104, "y": 103})
-// We click on the left of the "1" span but still in the "line-number" `<pre>`.
+// We click on the left of the "1" span but still in the "src-line-number" `<pre>`.
 click: (103, 103)
 assert-document-property: ({"URL": "/lib.rs.html"}, ENDS_WITH)
 

Original file line number	Diff line number	Diff line change
`@@ -578,7 +578,7 @@ h2.location a {`
`578`	`578`	`position: relative;`
`579`	`579`	`}`
`580`	`580`
`581`		`-.example-wrap > pre.line-number {`
	`581`	`+.example-wrap > pre.example-line-numbers {`
`582`	`582`	`overflow: initial;`
`583`	`583`	`border: 1px solid;`
`584`	`584`	`padding: 13px 8px;`
`@@ -591,15 +591,15 @@ h2.location a {`
`591`	`591`	`text-decoration: underline;`
`592`	`592`	`}`
`593`	`593`
`594`		`-.line-numbers {`
	`594`	`+.src-line-numbers {`
`595`	`595`	`text-align: right;`
`596`	`596`	`}`
`597`		`-.rustdoc:not(.source) .example-wrap > pre:not(.line-number) {`
	`597`	`+.rustdoc:not(.source) .example-wrap > pre:not(.example-line-numbers) {`
`598`	`598`	`width: 100%;`
`599`	`599`	`overflow-x: auto;`
`600`	`600`	`}`
`601`	`601`
`602`		`-.rustdoc:not(.source) .example-wrap > pre.line-numbers {`
	`602`	`+.rustdoc:not(.source) .example-wrap > pre.src-line-numbers {`
`603`	`603`	`width: auto;`
`604`	`604`	`overflow-x: visible;`
`605`	`605`	`}`
`@@ -612,14 +612,14 @@ h2.location a {`
`612`	`612`	`text-align: center;`
`613`	`613`	`}`
`614`	`614`
`615`		`-.content > .example-wrap pre.line-numbers {`
	`615`	`+.content > .example-wrap pre.src-line-numbers {`
`616`	`616`	`position: relative;`
`617`	`617`	`-webkit-user-select: none;`
`618`	`618`	`-moz-user-select: none;`
`619`	`619`	`-ms-user-select: none;`
`620`	`620`	`user-select: none;`
`621`	`621`	`}`
`622`		`-.line-numbers span {`
	`622`	`+.src-line-numbers span {`
`623`	`623`	`cursor: pointer;`
`624`	`624`	`}`
`625`	`625`
`@@ -2067,7 +2067,7 @@ in storage.js plus the media query with (min-width: 701px)`
`2067`	`2067`	`padding-bottom: 0;`
`2068`	`2068`	`}`
`2069`	`2069`
`2070`		`-.scraped-example:not(.expanded) .code-wrapper pre.line-numbers {`
	`2070`	`+.scraped-example:not(.expanded) .code-wrapper pre.src-line-numbers {`
`2071`	`2071`	`overflow-x: hidden;`
`2072`	`2072`	`}`
`2073`	`2073`
`@@ -2113,12 +2113,12 @@ in storage.js plus the media query with (min-width: 701px)`
`2113`	`2113`	`bottom: 0;`
`2114`	`2114`	`}`
`2115`	`2115`
`2116`		`-.scraped-example .code-wrapper .line-numbers {`
	`2116`	`+.scraped-example .code-wrapper .src-line-numbers {`
`2117`	`2117`	`margin: 0;`
`2118`	`2118`	`padding: 14px 0;`
`2119`	`2119`	`}`
`2120`	`2120`
`2121`		`-.scraped-example .code-wrapper .line-numbers span {`
	`2121`	`+.scraped-example .code-wrapper .src-line-numbers span {`
`2122`	`2122`	`padding: 0 14px;`
`2123`	`2123`	`}`
`2124`	`2124`
Original file line number	Diff line number	Diff line change
`@@ -93,8 +93,8 @@ pre, .rustdoc.source .example-wrap {`
`93`	`93`	`color: #ff7733;`
`94`	`94`	`}`
`95`	`95`
`96`		`-.line-numbers span { color: #5c6773; }`
`97`		`-.line-numbers .line-highlighted {`
	`96`	`+.src-line-numbers span { color: #5c6773; }`
	`97`	`+.src-line-numbers .line-highlighted {`
`98`	`98`	`color: #708090;`
`99`	`99`	`background-color: rgba(255, 236, 164, 0.06);`
`100`	`100`	`padding-right: 4px;`
`@@ -171,7 +171,7 @@ details.rustdoc-toggle > summary::before {`
`171`	`171`	`color: #788797;`
`172`	`172`	`}`
`173`	`173`
`174`		`-.line-numbers :target { background-color: transparent; }`
	`174`	`+.src-line-numbers :target { background-color: transparent; }`
`175`	`175`
`176`	`176`	`/* Code highlighting */`
`177`	`177`	`pre.rust .number, pre.rust .string { color: #b8cc52; }`
`@@ -190,7 +190,7 @@ pre.rust .attribute {`
`190`	`190`	`color: #e6e1cf;`
`191`	`191`	`}`
`192`	`192`
`193`		`-.example-wrap > pre.line-number {`
	`193`	`+.example-wrap > pre.example-line-numbers {`
`194`	`194`	`color: #5c67736e;`
`195`	`195`	`border: none;`
`196`	`196`	`}`
Original file line number	Diff line number	Diff line change
`@@ -54,8 +54,8 @@ input:focus + .slider {`
`54`	`54`	`background: #444;`
`55`	`55`	`}`
`56`	`56`
`57`		`-.line-numbers span { color: #3B91E2; }`
`58`		`-.line-numbers .line-highlighted {`
	`57`	`+.src-line-numbers span { color: #3B91E2; }`
	`58`	`+.src-line-numbers .line-highlighted {`
`59`	`59`	`background-color: #0a042f !important;`
`60`	`60`	`}`
`61`	`61`
`@@ -141,7 +141,7 @@ details.rustdoc-toggle > summary::before {`
`141`	`141`	`background: none;`
`142`	`142`	`}`
`143`	`143`
`144`		`-.line-numbers :target { background-color: transparent; }`
	`144`	`+.src-line-numbers :target { background-color: transparent; }`
`145`	`145`
`146`	`146`	`/* Code highlighting */`
`147`	`147`	`pre.rust .kw { color: #ab8ac1; }`
`@@ -155,7 +155,7 @@ pre.rust .question-mark {`
`155`	`155`	`color: #ff9011;`
`156`	`156`	`}`
`157`	`157`
`158`		`-.example-wrap > pre.line-number {`
	`158`	`+.example-wrap > pre.example-line-numbers {`
`159`	`159`	`border-color: #4a4949;`
`160`	`160`	`}`
`161`	`161`
Original file line number	Diff line number	Diff line change
`@@ -53,8 +53,8 @@ input:focus + .slider {`
`53`	`53`	`background-color: #fff;`
`54`	`54`	`}`
`55`	`55`
`56`		`-.line-numbers span { color: #c67e2d; }`
`57`		`-.line-numbers .line-highlighted {`
	`56`	`+.src-line-numbers span { color: #c67e2d; }`
	`57`	`+.src-line-numbers .line-highlighted {`
`58`	`58`	`background-color: #FDFFD3 !important;`
`59`	`59`	`}`
`60`	`60`
`@@ -125,7 +125,7 @@ body.source .example-wrap pre.rust a {`
`125`	`125`	`.stab { background: #FFF5D6; border-color: #FFC600; }`
`126`	`126`	`.stab.portability > code { background: none; }`
`127`	`127`
`128`		`-.line-numbers :target { background-color: transparent; }`
	`128`	`+.src-line-numbers :target { background-color: transparent; }`
`129`	`129`
`130`	`130`	`/* Code highlighting */`
`131`	`131`	`pre.rust .kw { color: #8959A8; }`
`@@ -141,7 +141,7 @@ pre.rust .question-mark {`
`141`	`141`	`color: #ff9011;`
`142`	`142`	`}`
`143`	`143`
`144`		`-.example-wrap > pre.line-number {`
	`144`	`+.example-wrap > pre.example-line-numbers {`
`145`	`145`	`border-color: #c7c7c7;`
`146`	`146`	`}`
`147`	`147`