rustdoc: remove unused CSS class `in-band` #102672

notriddle · 2022-10-04T18:55:41Z

Since a7c25b2 removed in-band from code headers, the only remaining uses of the in-band class are:

rust/src/librustdoc/html/render/write_shared.rs

Lines 520 to 521 in 02cd79a

    
                           "<h1 class=\"fqn\">\ 
        
                                <span class=\"in-band\">List of all crates</span>\

rust/src/librustdoc/html/templates/print_item.html

Lines 2 to 3 in 02cd79a

    
           <h1 class="fqn"> {#- -#} 
        
               <span class="in-band"> {#- -#}

rust/src/librustdoc/html/render/context.rs

Lines 637 to 638 in 02cd79a

    
                                <h1 class=\"fqn\">\ 
        
                                    <span class=\"in-band\">Rustdoc settings</span>\

rust/src/librustdoc/html/render/mod.rs

Lines 368 to 369 in 02cd79a

    
                       "<h1 class=\"fqn\">\ 
        
                            <span class=\"in-band\">List of all items</span>\

rust/src/librustdoc/html/render/mod.rs

Lines 401 to 402 in 02cd79a

    
                       <h1 class=\"fqn\">\ 
        
                           <span class=\"in-band\">About scraped examples</span>\

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

Line 525 in 02cd79a

    
           const traitName = document.querySelector("h1.fqn > .in-band > .trait").textContent;

Since all of these uses are nested below h1.fqn, we can get rid of it, and the support code that was used for when in-band was part of item rendering.

rustbot · 2022-10-04T18:55:44Z

Some changes occurred in HTML/CSS/JS.

cc @GuillaumeGomez, @Folyd, @jsha

rust-highfive · 2022-10-04T18:55:44Z

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @GuillaumeGomez (or someone else) soon.

Please see the contribution instructions for more information.

GuillaumeGomez · 2022-10-04T19:01:00Z

src/librustdoc/html/render/context.rs

                     <h1 class=\"fqn\">\
-                         <span class=\"in-band\">Rustdoc settings</span>\
+                         Rustdoc settings\
                     </h1>\


I think we can inline it completely at this point:

Suggested change

<h1 class=\"fqn\">\

<span class=\"in-band\">Rustdoc settings</span>\

Rustdoc settings\

</h1>\

<h1 class=\"fqn\">Rustdoc settings</h1>\

GuillaumeGomez · 2022-10-04T19:01:47Z

src/librustdoc/html/render/mod.rs

            "<h1 class=\"fqn\">\
-                 <span class=\"in-band\">List of all items</span>\
+                 List of all items\
             </h1>",


Same here:

Suggested change

"<h1 class=\"fqn\">\

<span class=\"in-band\">List of all items</span>\

List of all items\

</h1>",

"<h1 class=\"fqn\">List of all items</h1>",

GuillaumeGomez · 2022-10-04T19:02:05Z

src/librustdoc/html/render/write_shared.rs

@@ -518,7 +518,7 @@ if (typeof exports !== 'undefined') {exports.searchIndex = searchIndex};

            let content = format!(
                "<h1 class=\"fqn\">\
-                     <span class=\"in-band\">List of all crates</span>\
+                     List of all crates\


GuillaumeGomez · 2022-10-04T19:02:45Z

src/librustdoc/html/static/css/rustdoc.css

-	/* Then override it with `anywhere`, which is required to make non-Safari browsers break
-	   more aggressively when we want them to. */
-	overflow-wrap: anywhere;
-	background-color: var(--main-background-color);


No more background?

It's not needed. The fqn is always right on top of a regular background of the same color anyway.

Just confirmed it. 👍

GuillaumeGomez · 2022-10-04T19:03:40Z

Do you have an online by any chance? I'd love to be able to take a look at the result.

notriddle · 2022-10-04T19:35:35Z

@GuillaumeGomez Okay, preview: http://notriddle.com/notriddle-rustdoc-demos/fqn-in-band/

GuillaumeGomez · 2022-10-04T19:41:04Z

Apart the small nits, looks all good to me. r=me once they're fixed.

notriddle · 2022-10-04T21:16:39Z

@bors r=GuillaumeGomez rollup

bors · 2022-10-04T21:16:41Z

📌 Commit f7a1d695612d33680ec62273266c9d6a664f00e8 has been approved by GuillaumeGomez

It is now in the queue for this repository.

bors · 2022-10-05T11:42:45Z

☔ The latest upstream changes (presumably #102691) made this pull request unmergeable. Please resolve the merge conflicts.

Since a7c25b2 removed `in-band` from code headers, the only remaining uses of the `in-band` class are: https://github.com/rust-lang/rust/blob/02cd79afb8080fce8c8ce35533c54d8ecf8f390e/src/librustdoc/html/render/write_shared.rs#L520-L521 https://github.com/rust-lang/rust/blob/02cd79afb8080fce8c8ce35533c54d8ecf8f390e/src/librustdoc/html/templates/print_item.html#L2-L3 https://github.com/rust-lang/rust/blob/02cd79afb8080fce8c8ce35533c54d8ecf8f390e/src/librustdoc/html/render/context.rs#L637-L638 https://github.com/rust-lang/rust/blob/02cd79afb8080fce8c8ce35533c54d8ecf8f390e/src/librustdoc/html/render/mod.rs#L368-L369 https://github.com/rust-lang/rust/blob/02cd79afb8080fce8c8ce35533c54d8ecf8f390e/src/librustdoc/html/render/mod.rs#L401-L402 https://github.com/rust-lang/rust/blob/02cd79afb8080fce8c8ce35533c54d8ecf8f390e/src/librustdoc/html/static/js/main.js#L525 Since all of these uses are nested below `h1.fqn`, we can get rid of it, and the support code that was used for when `in-band` was part of item rendering.

notriddle · 2022-10-06T00:33:48Z

@bors r=GuillaumeGomez rollup

bors · 2022-10-06T00:33:49Z

📌 Commit 3cb03cb has been approved by GuillaumeGomez

It is now in the queue for this repository.

…iaskrgr Rollup of 5 pull requests Successful merges: - rust-lang#102672 (rustdoc: remove unused CSS class `in-band`) - rust-lang#102693 (Revert "Use getentropy when possible on all Apple platforms") - rust-lang#102694 (Suggest calling method if fn does not exist) - rust-lang#102708 (Suggest `==` to wrong assign expr) - rust-lang#102710 (Add test for issue 82633) Failed merges: r? `@ghost` `@rustbot` modify labels: rollup

rust-highfive assigned GuillaumeGomez Oct 4, 2022

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

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

GuillaumeGomez reviewed Oct 4, 2022

View reviewed changes

notriddle force-pushed the notriddle/fqn-in-band branch from 38971af to aa7aa91 Compare October 4, 2022 19:43

GuillaumeGomez approved these changes Oct 4, 2022

View reviewed changes

This comment has been minimized.

Sign in to view

notriddle force-pushed the notriddle/fqn-in-band branch from aa7aa91 to f7a1d69 Compare October 4, 2022 20:25

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 Oct 4, 2022

notriddle mentioned this pull request Oct 5, 2022

Rollup of 4 pull requests #102690

Closed

bors added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. labels Oct 5, 2022

notriddle force-pushed the notriddle/fqn-in-band branch from f7a1d69 to 3cb03cb Compare October 5, 2022 23:56

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-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Oct 6, 2022

matthiaskrgr mentioned this pull request Oct 6, 2022

Rollup of 5 pull requests #102726

Merged

bors merged commit 5f5b7b8 into rust-lang:master Oct 6, 2022

rustbot added this to the 1.66.0 milestone Oct 6, 2022

notriddle deleted the notriddle/fqn-in-band branch October 6, 2022 13:35

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

rustdoc: remove unused CSS class `in-band` #102672

rustdoc: remove unused CSS class `in-band` #102672

notriddle commented Oct 4, 2022

rustbot commented Oct 4, 2022

rust-highfive commented Oct 4, 2022

GuillaumeGomez Oct 4, 2022

GuillaumeGomez Oct 4, 2022

GuillaumeGomez Oct 4, 2022

GuillaumeGomez Oct 4, 2022

notriddle Oct 4, 2022

GuillaumeGomez Oct 4, 2022

GuillaumeGomez commented Oct 4, 2022

notriddle commented Oct 4, 2022

GuillaumeGomez commented Oct 4, 2022

This comment has been minimized.

notriddle commented Oct 4, 2022

bors commented Oct 4, 2022

bors commented Oct 5, 2022

notriddle commented Oct 6, 2022

bors commented Oct 6, 2022

	"<h1 class=\"fqn\">\
	<span class=\"in-band\">List of all crates</span>\

	<h1 class=\"fqn\">\
	<span class=\"in-band\">Rustdoc settings</span>\

	"<h1 class=\"fqn\">\
	<span class=\"in-band\">List of all items</span>\

	<h1 class=\"fqn\">\
	<span class=\"in-band\">About scraped examples</span>\

rustdoc: remove unused CSS class in-band #102672

rustdoc: remove unused CSS class in-band #102672

Conversation

notriddle commented Oct 4, 2022

rustbot commented Oct 4, 2022

rust-highfive commented Oct 4, 2022

GuillaumeGomez Oct 4, 2022

Choose a reason for hiding this comment

GuillaumeGomez Oct 4, 2022

Choose a reason for hiding this comment

GuillaumeGomez Oct 4, 2022

Choose a reason for hiding this comment

GuillaumeGomez Oct 4, 2022

Choose a reason for hiding this comment

notriddle Oct 4, 2022

Choose a reason for hiding this comment

GuillaumeGomez Oct 4, 2022

Choose a reason for hiding this comment

GuillaumeGomez commented Oct 4, 2022

notriddle commented Oct 4, 2022

GuillaumeGomez commented Oct 4, 2022

This comment has been minimized.

notriddle commented Oct 4, 2022

bors commented Oct 4, 2022

bors commented Oct 5, 2022

notriddle commented Oct 6, 2022

bors commented Oct 6, 2022

rustdoc: remove unused CSS class `in-band` #102672

rustdoc: remove unused CSS class `in-band` #102672