Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[rustdoc] Docs search gives overly narrow results #75430

Closed
Lokathor opened this issue Aug 12, 2020 · 4 comments
Closed

[rustdoc] Docs search gives overly narrow results #75430

Lokathor opened this issue Aug 12, 2020 · 4 comments
Labels
A-rustdoc-search Area: Rustdoc's search feature C-bug Category: This is a bug. E-needs-bisection Call for participation: This issue needs bisection: https://github.com/rust-lang/cargo-bisect-rustc E-needs-mcve Call for participation: This issue has a repro, but needs a Minimal Complete and Verifiable Example T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@Lokathor
Copy link
Contributor

When searching through a crate using generated docs, the search doesn't show the correct results. Specifically, if you go to a page such as this one we can see that there are many many functions with mul_ as part of their name. And yet, when you change mul to mul_ in the search box, the results are filtered to only 6 results.

On top of that, four of the six results don't even actually contain the string mul_ in their name.

@jyn514 jyn514 added C-bug Category: This is a bug. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. labels Aug 12, 2020
@jyn514
Copy link
Member

jyn514 commented Aug 12, 2020

At first I thought this was related to #75347, but https://docs.rs/safe_arch/0.5.1/safe_arch/?search=mul was published earlier and also reproduces the issue.

This needs a bisection, ideas for doing so in the dropdown for #74780.

@jyn514 jyn514 added the E-needs-bisection Call for participation: This issue needs bisection: https://github.com/rust-lang/cargo-bisect-rustc label Aug 12, 2020
@siddharthzs
Copy link

I would like to take this up.

@jyn514
Copy link
Member

jyn514 commented Sep 4, 2020

@siddharthzs this is not trivial to fix ... but if you want to help it would be great to find out when the error first started happening (or if it's always been a bug). There's instructions for bisecting search regressions in #74780.

@jyn514 jyn514 added the E-needs-mcve Call for participation: This issue has a repro, but needs a Minimal Complete and Verifiable Example label Sep 4, 2020
@camelid camelid added the A-rustdoc-search Area: Rustdoc's search feature label Oct 17, 2020
@notriddle
Copy link
Contributor

I built the docs for safe_arch 0.5.2 with a current nightly and cannot reproduce it. I can reproduce it with the docs.rs link, demonstrating the thing that changed is search.js, and not, for example, my browser.

http://notriddle.com/rustdoc-html-demo-8/safe_arch/safe_arch/index.html?search=mul

http://notriddle.com/rustdoc-html-demo-8/safe_arch/safe_arch/index.html?search=mul_

I'm closing this, since it's almost certainly fixed (a lot of search code has been rewritten in the last three years).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-rustdoc-search Area: Rustdoc's search feature C-bug Category: This is a bug. E-needs-bisection Call for participation: This issue needs bisection: https://github.com/rust-lang/cargo-bisect-rustc E-needs-mcve Call for participation: This issue has a repro, but needs a Minimal Complete and Verifiable Example T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Development

No branches or pull requests

6 participants