Move crate drop-down to search results page #92490

jsha · 2022-01-02T05:37:31Z

This reduces clutter on doc pages.

Part of #59840

r? @GuillaumeGomez

Demo: https://rustdoc.crud.net/jsha/crates-in-results/std/index.html?search=str

rust-highfive · 2022-01-02T05:37:33Z

Some changes occurred in HTML/CSS/JS.

cc @GuillaumeGomez

GuillaumeGomez · 2022-01-02T17:07:58Z

src/librustdoc/html/static/js/search.js

@@ -1126,9 +1126,16 @@ window.initSearch = function(rawSearchIndex) {
            }
        }

-        var output = "<h1>Results for " + escape(query.query) +
+        let crates = `<select id="crate-search"><option value="All crates">All crates</option>`;


Isn't eslint complaining when you use backticks without ${} content?

Nope! I wouldn't expect it to. Backticks do a bunch of things besides template expansion. They also allow multiline strings, and serve as a different delimiter so you don't have to backslash double quotes (\")

GuillaumeGomez · 2022-01-02T17:11:24Z

As said previously, I really like it! The display needs a bit of improvement: the in is too small I think (but maybe it's voluntary?). Maybe we should force the dropdown to be on its own line on mobile? Currently it gives (with long search string):

The style of the dropdown is incomplete I think: the border is looking strange.

In any case, it's a nice start. :)

jsha · 2022-01-02T18:25:42Z

the in is too small I think (but maybe it's voluntary?).

This was on purpose, since in ____ isn't part of the title (<h1>). But I could make it the same size as the <h1>, just outside the tag? I don't have a strong opinion about what's better.

Maybe we should force the dropdown to be on its own line on mobile?

Good idea.

camelid · 2022-01-02T20:32:55Z

I also had an idea recently that could help with this (I forget if I mentioned it or not). We could add a crate:some_crate search syntactical form. Then we could add it as an option to the advanced search builder @jsha proposed.

camelid · 2022-01-02T20:33:51Z

This was on purpose, since in ____ isn't part of the title (<h1>). But I could make it the same size as the <h1>, just outside the tag? I don't have a strong opinion about what's better.

It looks very strange to me. The select also renders differently from how it used to:

The bezel seems a bit extreme.

jsha · 2022-01-02T20:49:57Z

Interesting! What platform is that?

…

On Sun, Jan 2, 2022, 15:34 Noah Lev ***@***.***> wrote: This was on purpose, since in ____ isn't part of the title (<h1>). But I could make it the same size as the <h1>, just outside the tag? I don't have a strong opinion about what's better. It looks very strange to me. The select also renders differently from how it used to: [image: image] <https://user-images.githubusercontent.com/37223377/147888752-2fb95576-3e30-46b7-a88c-7b21b31b1043.png> The bezel seems a bit extreme. — Reply to this email directly, view it on GitHub <#92490 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AABVYLO4MM3EECR7FYWDTDLUUCZDXANCNFSM5LDI6S3A> . Triage notifications on the go with GitHub Mobile for iOS <https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675> or Android <https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub>. You are receiving this because you were mentioned.Message ID: ***@***.***>

camelid · 2022-01-02T20:50:19Z

Firefox on macOS.

jsha · 2022-01-03T01:25:35Z

Alright, I've increased the size of in and fixed the border issue (I had overzealously removed a border:0 in the CSS that turned out to be needed). I also tweaked the padding slightly. Demo is pushed and ready for another look!

GuillaumeGomez · 2022-01-05T16:31:28Z

src/librustdoc/html/static/js/search.js

            (query.type ? " (type: " + escape(query.type) + ")" : "") + "</h1>" +
-            "<div id=\"titles\">" +
+            ` in ${crates} ` +
+            "</div><div id=\"titles\">" +


I think backticks would be better here as well.

GuillaumeGomez · 2022-01-05T16:32:15Z

src/ci/docker/host-x86_64/mingw-check/Dockerfile

@@ -40,5 +40,5 @@ ENV SCRIPT python3 ../x.py --stage 2 test src/tools/expand-yaml-anchors && \
           /scripts/validate-toolstate.sh && \
           /scripts/validate-error-codes.sh && \
           # Runs checks to ensure that there are no ES5 issues in our JS code.
-           es-check es5 ../src/librustdoc/html/static/js/*.js && \
+           es-check es6 ../src/librustdoc/html/static/js/*.js && \


We wanted to make this change in bigger PR but I guess it's fine... Don't forget to update the comment just above please.

I actually think a giant PR adding ES6 features wherever possible, and updating the linter at the same time would be a bad idea. The way we should do it is like I'm doing here:

update the linter to accept es6 as a standalone commit

start using es6 features where they are useful

do a series of standalone commits that do one of two things:

adopt an ES6 feature where it is useful (e.g. const everything that can be consted), or

migrate a discrete chunk of code to using various useful ES6 features.

Like I said, it's fine. 😉

Also update Node to v16.9.0, es-check to 6.1.1, and eslint to 8.6.0.

This reduces clutter on doc pages.

GuillaumeGomez · 2022-01-05T20:23:00Z

Thanks!

@bors: r+

bors · 2022-01-05T20:23:01Z

📌 Commit 8abb4bb has been approved by GuillaumeGomez

…Gomez Move crate drop-down to search results page This reduces clutter on doc pages. Part of rust-lang#59840 r? `@GuillaumeGomez` Demo: https://rustdoc.crud.net/jsha/crates-in-results/std/index.html?search=str

…Gomez Move crate drop-down to search results page This reduces clutter on doc pages. Part of rust-lang#59840 r? ``@GuillaumeGomez`` Demo: https://rustdoc.crud.net/jsha/crates-in-results/std/index.html?search=str

…askrgr Rollup of 8 pull requests Successful merges: - rust-lang#92055 (Add release notes for 1.58) - rust-lang#92490 (Move crate drop-down to search results page) - rust-lang#92510 (Don't resolve blocks in foreign functions) - rust-lang#92573 (expand: Refactor InvocationCollector visitor for better code reuse) - rust-lang#92608 (rustdoc: Introduce a resolver cache for sharing data between early doc link resolution and later passes) - rust-lang#92657 (Implemented const casts of raw pointers) - rust-lang#92671 (Make `Atomic*::from_mut` return `&mut Atomic*`) - rust-lang#92673 (Remove useless collapse toggle on "all items" page) Failed merges: r? `@ghost` `@rustbot` modify labels: rollup

rust-highfive assigned GuillaumeGomez Jan 2, 2022

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

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

This comment has been minimized.

# to view

jsha mentioned this pull request Jan 2, 2022

Controls and search in Rustdoc header are visually distracting #59840

Open

8 tasks

GuillaumeGomez reviewed Jan 2, 2022

View reviewed changes

jsha force-pushed the crates-in-results branch 3 times, most recently from 6958519 to 3f3b976 Compare January 3, 2022 01:22

This comment has been minimized.

# to view

jsha force-pushed the crates-in-results branch from 3f3b976 to 8abe0ab Compare January 5, 2022 05:27

camelid added the A-rustdoc-ui Area: Rustdoc UI (generated HTML) label Jan 5, 2022

jsha mentioned this pull request Jan 5, 2022

Simplify rustdoc search test #92570

Merged

This comment has been minimized.

# to view

jsha force-pushed the crates-in-results branch from 8abe0ab to 5c3e82a Compare January 5, 2022 14:57

This comment has been minimized.

# to view

GuillaumeGomez reviewed Jan 5, 2022

View reviewed changes

jsha added 2 commits January 5, 2022 11:44

Switch to es6 for eslint

f3fe912

Also update Node to v16.9.0, es-check to 6.1.1, and eslint to 8.6.0.

Move crate drop-down to search results page

8abb4bb

This reduces clutter on doc pages.

jsha force-pushed the crates-in-results branch from 5c3e82a to 8abb4bb Compare January 5, 2022 17:57

GuillaumeGomez approved these changes Jan 5, 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 Jan 5, 2022

matthiaskrgr mentioned this pull request Jan 5, 2022

Rollup of 7 pull requests #92593

Closed

matthiaskrgr mentioned this pull request Jan 6, 2022

Rollup of 7 pull requests #92616

Closed

matthiaskrgr mentioned this pull request Jan 9, 2022

Rollup of 8 pull requests #92690

Merged

bors merged commit 598364c into rust-lang:master Jan 9, 2022

rustbot added this to the 1.60.0 milestone Jan 9, 2022

GuillaumeGomez mentioned this pull request Feb 17, 2022

T keyboard shortcut no longer functions on new docs layout #94048

Closed

Move crate drop-down to search results page #92490

Move crate drop-down to search results page #92490

Uh oh!

Conversation

jsha commented Jan 2, 2022

Uh oh!

rust-highfive commented Jan 2, 2022

Uh oh!

This comment has been minimized.

This comment has been minimized.

GuillaumeGomez Jan 2, 2022

Choose a reason for hiding this comment

Uh oh!

jsha Jan 2, 2022

Choose a reason for hiding this comment

Uh oh!

GuillaumeGomez commented Jan 2, 2022

Uh oh!

jsha commented Jan 2, 2022

Uh oh!

camelid commented Jan 2, 2022

Uh oh!

camelid commented Jan 2, 2022

Uh oh!

jsha commented Jan 2, 2022 via email

Uh oh!

camelid commented Jan 2, 2022

Uh oh!

jsha commented Jan 3, 2022

Uh oh!

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

GuillaumeGomez Jan 5, 2022

Choose a reason for hiding this comment

Uh oh!

GuillaumeGomez Jan 5, 2022

Choose a reason for hiding this comment

Uh oh!

jsha Jan 5, 2022

Choose a reason for hiding this comment

Uh oh!

GuillaumeGomez Jan 5, 2022

Choose a reason for hiding this comment

Uh oh!

GuillaumeGomez commented Jan 5, 2022

Uh oh!

bors commented Jan 5, 2022

Uh oh!

Uh oh!