Improve no result found sentence in doc search #55563

GuillaumeGomez · 2018-11-01T01:22:40Z

Look:

varkor · 2018-11-01T10:36:45Z

src/librustdoc/html/static/main.js

@@ -1340,7 +1340,13 @@
                output = '<div class="search-failed"' + extraStyle + '>No results :(<br/>' +
                    'Try on <a href="https://duckduckgo.com/?q=' +
                    encodeURIComponent('rust ' + query.query) +
-                    '">DuckDuckGo</a>?</div>';
+                    '">DuckDuckGo</a>?<br/><br/>' +
+                    'Or maybe you want to take a look to the <a ' +


"Take a look at" or "Look in" sounds more natural here (and in "or to" below).

When doc searches are in other crates and not std, the "or maybe you want" might not apply as often. The following is a plain option that links to the full Rust Documentation page for providing descriptions and additional resources:

Rust Documentation provides additional resources and guides, such as the Rust Book, Rust by Example, and the Rust Reference.

varkor · 2018-11-01T10:40:44Z

Maybe it's worth being even more explicit:

Or try looking in one of these:
- The [Rust Reference] for technical details about the language.
- [Rust by Example] for expository code examples.
- The [Rust Book] for introductions to language features and the language itself.

Just in case the reader isn't familiar with them already (there's enough spare room).

QuietMisdreavus · 2018-11-02T14:29:45Z

If this is going to be in every doc build and not just std (as it is right now), then i'm wary about this. Imagine you're looking for something in hyper's docs and get linked to std. If we're going to link to all of these things, I like @varkor's suggestion, but we could also include a link to docs.rs, such as:

- [Docs.rs] for documentation on third-party crates.

GuillaumeGomez · 2018-11-02T15:13:29Z

Way better indeed! I'll use @varkor's suggestion.

GuillaumeGomez · 2018-11-04T12:06:10Z

New look:

QuietMisdreavus · 2018-11-05T14:50:07Z

Looks good to me! @varkor @memoryruins, what do y'all think?

memoryruins · 2018-11-05T17:55:30Z

I like it :) the links will be useful!

Since the new list looks best left-aligned yet is logically grouped with the "result not found" text, thoughts on left-aligning everything altogether?

The left side is where my eyes already go when expecting a result, and it keeps the groups alignment consistent.

Instead of using the term "third-party" on the Docs.rs description, should we say

- [Docs.rs] for documentation of crates released on crates.io

Some rust-nursery crates are nearly std and it could be helpful to specify the origin of the generated docs.

varkor · 2018-11-06T10:24:50Z

src/librustdoc/html/static/main.js

+                    '</a> for expository code examples.</a></li><li>The <a ' +
+                    'href="https://doc.rust-lang.org/book/index.html">Rust Book</a> for ' +
+                    'introductions to language features and the language itself.</li><li><a ' +
+                    'href="https://docs.rs">Docs.rs</a> for documentation on third-party crates.' +


Perhaps documentation of third-party crates.

varkor · 2018-11-06T10:25:29Z

Looks good to me!

QuietMisdreavus · 2018-11-12T22:32:06Z

+1 to @memoryruins' wording suggestion.

GuillaumeGomez · 2018-11-21T18:45:30Z

Updated the wording.

QuietMisdreavus

Thanks so much! This looks good to me.

QuietMisdreavus · 2018-12-03T15:13:51Z

@bors r+ rollup

bors · 2018-12-03T15:13:52Z

📌 Commit c209ed8 has been approved by QuietMisdreavus

@QuietMisdreavus

… r=QuietMisdreavus Improve no result found sentence in doc search Fixes rust-lang#55531. Look: <img width="1440" alt="screenshot 2018-11-01 at 02 21 56" src="https://user-images.githubusercontent.com/3050060/47827257-f6236c80-dd7c-11e8-9ea9-99c8cb4b2de5.png"> r? @QuietMisdreavus

@QuietMisdreavus

… r=QuietMisdreavus Improve no result found sentence in doc search Fixes rust-lang#55531. Look: <img width="1440" alt="screenshot 2018-11-01 at 02 21 56" src="https://user-images.githubusercontent.com/3050060/47827257-f6236c80-dd7c-11e8-9ea9-99c8cb4b2de5.png"> r? @QuietMisdreavus

@QuietMisdreavus

… r=QuietMisdreavus Improve no result found sentence in doc search Fixes rust-lang#55531. Look: <img width="1440" alt="screenshot 2018-11-01 at 02 21 56" src="https://user-images.githubusercontent.com/3050060/47827257-f6236c80-dd7c-11e8-9ea9-99c8cb4b2de5.png"> r? @QuietMisdreavus

@QuietMisdreavus

… r=QuietMisdreavus Improve no result found sentence in doc search Fixes rust-lang#55531. Look: <img width="1440" alt="screenshot 2018-11-01 at 02 21 56" src="https://user-images.githubusercontent.com/3050060/47827257-f6236c80-dd7c-11e8-9ea9-99c8cb4b2de5.png"> r? @QuietMisdreavus

@QuietMisdreavus

… r=QuietMisdreavus Improve no result found sentence in doc search Fixes rust-lang#55531. Look: <img width="1440" alt="screenshot 2018-11-01 at 02 21 56" src="https://user-images.githubusercontent.com/3050060/47827257-f6236c80-dd7c-11e8-9ea9-99c8cb4b2de5.png"> r? @QuietMisdreavus

@ghost

Rollup of 15 pull requests Successful merges: - #51753 (Document `From` implementations) - #55563 (Improve no result found sentence in doc search) - #55987 (Add Weak.ptr_eq) - #56119 (Utilize `?` instead of `return None`.) - #56372 (Refer to the second borrow as the "second borrow" in E0501.rs) - #56388 (More MIR borrow check cleanup) - #56424 (Mention raw-ident syntax) - #56452 (Remove redundant clones) - #56456 (Handle existential types in dead code analysis) - #56466 (data_structures: remove tuple_slice) - #56476 (Fix invalid line number match) - #56497 (cleanup: remove static lifetimes from consts in libstd) - #56498 (Fix line numbers display) - #56523 (Added a bare-bones eslint config (removing jslint)) - #56538 (Use inner iterator may_have_side_effect for Cloned) Failed merges: r? @ghost

rust-highfive assigned QuietMisdreavus Nov 1, 2018

rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Nov 1, 2018

varkor reviewed Nov 1, 2018

View reviewed changes

GuillaumeGomez force-pushed the doc-search-sentence branch from 737f5af to 461e4be Compare November 4, 2018 12:05

varkor reviewed Nov 6, 2018

View reviewed changes

TimNN 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-review Status: Awaiting review from the assignee but also interested parties. labels Nov 20, 2018

Improve no result found sentence in doc search

c209ed8

GuillaumeGomez force-pushed the doc-search-sentence branch from 461e4be to c209ed8 Compare November 21, 2018 18:45

Dylan-DPC-zz added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Nov 26, 2018

QuietMisdreavus approved these changes Dec 3, 2018

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 Dec 3, 2018

kennytm mentioned this pull request Dec 4, 2018

Rollup of 12 pull requests #56506

Closed

GuillaumeGomez mentioned this pull request Dec 4, 2018

Rollup of 15 pull requests #56521

Closed

GuillaumeGomez mentioned this pull request Dec 5, 2018

Rollup of 19 pull requests #56531

Closed

pietroalbini mentioned this pull request Dec 5, 2018

Rollup of 25 pull requests #56547

Closed

pietroalbini mentioned this pull request Dec 5, 2018

Rollup of 15 pull requests #56549

Merged

bors merged commit c209ed8 into rust-lang:master Dec 6, 2018

GuillaumeGomez deleted the doc-search-sentence branch December 6, 2018 10:33

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve no result found sentence in doc search #55563

Improve no result found sentence in doc search #55563

GuillaumeGomez commented Nov 1, 2018

varkor Nov 1, 2018

memoryruins Nov 1, 2018

varkor commented Nov 1, 2018

QuietMisdreavus commented Nov 2, 2018 •

edited

Loading

GuillaumeGomez commented Nov 2, 2018

GuillaumeGomez commented Nov 4, 2018

QuietMisdreavus commented Nov 5, 2018

memoryruins commented Nov 5, 2018 •

edited

Loading

varkor Nov 6, 2018

varkor commented Nov 6, 2018

QuietMisdreavus commented Nov 12, 2018

GuillaumeGomez commented Nov 21, 2018

QuietMisdreavus left a comment

QuietMisdreavus commented Dec 3, 2018

bors commented Dec 3, 2018

Improve no result found sentence in doc search #55563

Improve no result found sentence in doc search #55563

Conversation

GuillaumeGomez commented Nov 1, 2018

varkor Nov 1, 2018

Choose a reason for hiding this comment

memoryruins Nov 1, 2018

Choose a reason for hiding this comment

varkor commented Nov 1, 2018

QuietMisdreavus commented Nov 2, 2018 • edited Loading

GuillaumeGomez commented Nov 2, 2018

GuillaumeGomez commented Nov 4, 2018

QuietMisdreavus commented Nov 5, 2018

memoryruins commented Nov 5, 2018 • edited Loading

varkor Nov 6, 2018

Choose a reason for hiding this comment

varkor commented Nov 6, 2018

QuietMisdreavus commented Nov 12, 2018

GuillaumeGomez commented Nov 21, 2018

QuietMisdreavus left a comment

Choose a reason for hiding this comment

QuietMisdreavus commented Dec 3, 2018

bors commented Dec 3, 2018

QuietMisdreavus commented Nov 2, 2018 •

edited

Loading

memoryruins commented Nov 5, 2018 •

edited

Loading