rustdoc: remove `docblock` class from `item-decl` #102027

notriddle · 2022-09-19T18:46:14Z

This class was originally added in 73b97c7 to support hiding and showing the item, because main.js went through all docblock elements in the DOM and added toggles to them.

rust/src/librustdoc/html/static/main.js

Lines 1856 to 1867 in 73b97c7

    
           onEach(document.getElementById('main').getElementsByClassName('docblock'), function(e) { 
        
               if (e.parentNode.id === "main") { 
        
                   var otherMessage; 
        
                   if (hasClass(e, "type-decl")) { 
        
                       otherMessage = '&nbsp;Show&nbsp;type&nbsp;declaration'; 
        
                   } 
        
                   e.parentNode.insertBefore(createToggle(otherMessage), e); 
        
                   if (otherMessage) { 
        
                       collapseDocs(e.previousSibling.childNodes[0], "toggle"); 
        
                   } 
        
               } 
        
           });

The item-decl is no longer auto-hidden since c96f86d removed it.

item-decl used to be called type-decl: that name was changed in 8b7a2dd.

The docblock class is no longer used for implementing toggles, since rustdoc switched to using <details> elements.

Preview: https://notriddle.com/notriddle-rustdoc-test/docblock-item-decl/rustdoc/clean/types/enum.Type.html

This class was originally added in 73b97c7 to support hiding and showing the item, because `main.js` went through all `docblock` elements in the DOM and added toggles to them. https://github.com/rust-lang/rust/blob/73b97c7e7c9cfac4dfa4804654b1db6ab687b589/src/librustdoc/html/static/main.js#L1856-L1867 The `item-decl` is no longer auto-hidden since c96f86d removed it. `item-decl` used to be called `type-decl`: that name was changed in 8b7a2dd. The `docblock` class is no longer used for implementing toggles, since rustdoc switched to using `<details>` elements.

rustbot · 2022-09-19T18:46:17Z

Some changes occurred in HTML/CSS/JS.

cc @GuillaumeGomez, @Folyd, @jsha

rust-highfive · 2022-09-19T18:46:17Z

r? @CraftSpider

(rust-highfive has picked a reviewer for you, use r? to override)

notriddle · 2022-09-19T21:45:24Z

r? @GuillaumeGomez

GuillaumeGomez · 2022-09-19T22:40:50Z

src/test/rustdoc/whitespace-after-where-clause.struct.html

@@ -1,4 +1,4 @@
-<div class="docblock item-decl"><pre class="rust struct"><code>pub struct Struct&lt;'a, B:&#160;?<a class="trait" href="{{channel}}/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + 'a&gt; <span class="where fmt-newline">where<br />&#160;&#160;&#160;&#160;B: <a class="trait" href="trait.ToOwned.html" title="trait foo::ToOwned">ToOwned</a>&lt;dyn <a class="trait" href="{{channel}}/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>&gt;,&#160;</span>{
+<div class="item-decl"><pre class="rust struct"><code>pub struct Struct&lt;'a, B:&#160;?<a class="trait" href="{{channel}}/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + 'a&gt;<span class="where fmt-newline">where<br />&#160;&#160;&#160;&#160;B: <a class="trait" href="trait.ToOwned.html" title="trait foo::ToOwned">ToOwned</a>&lt;dyn <a class="trait" href="{{channel}}/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>&gt;,</span>{


There seem to have more than a simple class removal in all these files. Any idea why? I can't figure it out simply from the code changes.

I expect that the whitespace changes happened in #99904, but these tests didn't start failing because

rust/src/etc/htmldocck.py

Line 438 in 2019147

not compare_tree(make_xml(actual_str), make_xml(expected_str), stderr)) \

normalizes the snapshot and result into a DOM tree before comparing them.

Oh I see. Then all good!

GuillaumeGomez · 2022-09-20T09:04:04Z

Thanks!

@bors r+ rollup

bors · 2022-09-20T09:04:05Z

📌 Commit 8e6cf7d has been approved by GuillaumeGomez

It is now in the queue for this repository.

…decl, r=GuillaumeGomez rustdoc: remove `docblock` class from `item-decl` This class was originally added in 73b97c7 to support hiding and showing the item, because `main.js` went through all `docblock` elements in the DOM and added toggles to them. https://github.com/rust-lang/rust/blob/73b97c7e7c9cfac4dfa4804654b1db6ab687b589/src/librustdoc/html/static/main.js#L1856-L1867 The `item-decl` is no longer auto-hidden since c96f86d removed it. `item-decl` used to be called `type-decl`: that name was changed in 8b7a2dd. The `docblock` class is no longer used for implementing toggles, since rustdoc switched to using `<details>` elements. Preview: https://notriddle.com/notriddle-rustdoc-test/docblock-item-decl/rustdoc/clean/types/enum.Type.html

Rollup of 12 pull requests Successful merges: - rust-lang#100250 (Manually cleanup token stream when macro expansion aborts.) - rust-lang#101014 (Fix -Zmeta-stats ICE by giving `FileEncoder` file read permissions) - rust-lang#101958 (Improve error for when query is unsupported by crate) - rust-lang#101976 (MirPhase: clarify that linting is not a semantic change) - rust-lang#102001 (Use LLVM C-API to build atomic cmpxchg and fence) - rust-lang#102008 (Add GUI test for notable traits element position) - rust-lang#102013 (Simplify rpitit handling on lower_fn_decl) - rust-lang#102021 (some post-valtree cleanup) - rust-lang#102027 (rustdoc: remove `docblock` class from `item-decl`) - rust-lang#102034 (rustdoc: remove no-op CSS `h1-6 { border-bottom-color }`) - rust-lang#102038 (Make the `normalize-overflow` rustdoc test actually do something) - rust-lang#102053 (:arrow_up: rust-analyzer) Failed merges: r? `@ghost` `@rustbot` modify labels: rollup

rust-highfive assigned CraftSpider Sep 19, 2022

rustbot added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Sep 19, 2022

rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Sep 19, 2022

This comment has been minimized.

Sign in to view

rustdoc: update test cases for changed item-decl HTML

8e6cf7d

notriddle force-pushed the notriddle/docblock-item-decl branch from 0bd23da to 8e6cf7d Compare September 19, 2022 20:39

rust-highfive assigned GuillaumeGomez and unassigned CraftSpider Sep 19, 2022

GuillaumeGomez reviewed Sep 19, 2022

View reviewed changes

bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Sep 20, 2022

Dylan-DPC mentioned this pull request Sep 20, 2022

Rollup of 6 pull requests #102046

Closed

spastorino mentioned this pull request Sep 20, 2022

Rollup of 8 pull requests #102050

Closed

This was referenced Sep 20, 2022

Rollup of 12 pull requests #102060

Closed

Rollup of 12 pull requests #102061

Merged

bors merged commit 1b54ee3 into rust-lang:master Sep 20, 2022

rustbot added this to the 1.66.0 milestone Sep 20, 2022

notriddle deleted the notriddle/docblock-item-decl branch September 20, 2022 22:02

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

rustdoc: remove `docblock` class from `item-decl` #102027

rustdoc: remove `docblock` class from `item-decl` #102027

notriddle commented Sep 19, 2022

rustbot commented Sep 19, 2022

rust-highfive commented Sep 19, 2022

This comment has been minimized.

notriddle commented Sep 19, 2022

GuillaumeGomez Sep 19, 2022

notriddle Sep 19, 2022

GuillaumeGomez Sep 20, 2022

GuillaumeGomez commented Sep 20, 2022

bors commented Sep 20, 2022

	onEach(document.getElementById('main').getElementsByClassName('docblock'), function(e) {
	if (e.parentNode.id === "main") {
	var otherMessage;
	if (hasClass(e, "type-decl")) {
	otherMessage = ' Show type declaration';
	}
	e.parentNode.insertBefore(createToggle(otherMessage), e);
	if (otherMessage) {
	collapseDocs(e.previousSibling.childNodes[0], "toggle");
	}
	}
	});

		@@ -1,4 +1,4 @@
		<div class="docblock item-decl"><pre class="rust struct"><code>pub struct Struct<'a, B: ?<a class="trait" href="{{channel}}/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + 'a> <span class="where fmt-newline">where<br />    B: <a class="trait" href="trait.ToOwned.html" title="trait foo::ToOwned">ToOwned</a><dyn <a class="trait" href="{{channel}}/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>>, </span>{
		<div class="item-decl"><pre class="rust struct"><code>pub struct Struct<'a, B: ?<a class="trait" href="{{channel}}/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + 'a><span class="where fmt-newline">where<br />    B: <a class="trait" href="trait.ToOwned.html" title="trait foo::ToOwned">ToOwned</a><dyn <a class="trait" href="{{channel}}/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>>,</span>{

rustdoc: remove docblock class from item-decl #102027

rustdoc: remove docblock class from item-decl #102027

Conversation

notriddle commented Sep 19, 2022

rustbot commented Sep 19, 2022

rust-highfive commented Sep 19, 2022

This comment has been minimized.

notriddle commented Sep 19, 2022

GuillaumeGomez Sep 19, 2022

Choose a reason for hiding this comment

notriddle Sep 19, 2022

Choose a reason for hiding this comment

GuillaumeGomez Sep 20, 2022

Choose a reason for hiding this comment

GuillaumeGomez commented Sep 20, 2022

bors commented Sep 20, 2022

rustdoc: remove `docblock` class from `item-decl` #102027

rustdoc: remove `docblock` class from `item-decl` #102027