Skip to content

Broken links in rustdoc search results #78724

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

Closed
arora-aman opened this issue Nov 4, 2020 · 8 comments
Closed

Broken links in rustdoc search results #78724

arora-aman opened this issue Nov 4, 2020 · 8 comments
Labels
A-rustdoc-search Area: Rustdoc's search feature C-bug Category: This is a bug. E-needs-mcve Call for participation: This issue has a repro, but needs a Minimal Complete and Verifiable Example ICEBreaker-Cleanup-Crew Helping to "clean up" bugs with minimal examples and bisections P-medium Medium priority T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@arora-aman
Copy link
Member

I searched for visit_with and when I select the first result rustc_middle::Ty::visit_with I get the Not Found page.

I expected to see a page containing the method visit_with.

Note: not all links are broken, just some.

@arora-aman arora-aman added the C-bug Category: This is a bug. label Nov 4, 2020
@jyn514 jyn514 added T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. A-rustdoc-search Area: Rustdoc's search feature labels Nov 4, 2020
@jyn514
Copy link
Member

jyn514 commented Nov 4, 2020

The correct url is rustc_middle/ty/type.Ty.html, but the search page shows rustc_middle/type.Ty.html#method.visit_with. Not sure why.

@camelid
Copy link
Member

camelid commented Nov 4, 2020

Seems like it might be a bug with type aliases.

@jyn514 jyn514 added the E-needs-mcve Call for participation: This issue has a repro, but needs a Minimal Complete and Verifiable Example label Nov 4, 2020
@camelid camelid added the I-prioritize Issue: Indicates that prioritization has been requested for this issue. label Nov 4, 2020
@camelid
Copy link
Member

camelid commented Nov 4, 2020

Note that the URL is wrong and the path is wrong. There's no such thing as rustc_middle::Ty::visit_with since it's not re-exported. So somewhere there's something awry with the path handling.

@camelid
Copy link
Member

camelid commented Nov 4, 2020

Note that the links to Ty in the trait implementations section on the Ty page are correct.

@apiraino
Copy link
Contributor

@rustbot ping cleanup

It would be interesting to investigate this issue a bit more in deep to isolate the issue better

@rustbot
Copy link
Collaborator

rustbot commented Nov 19, 2020

Hey Cleanup Crew ICE-breakers! This bug has been identified as a good
"Cleanup ICE-breaking candidate". In case it's useful, here are some
instructions for tackling these sorts of bugs. Maybe take a look?
Thanks! <3

cc @AminArria @camelid @chrissimpkins @contrun @DutchGhost @elshize @ethanboxx @h-michael @HallerPatrick @hdhoang @hellow554 @imtsuki @JamesPatrickGill @kanru @KarlK90 @LeSeulArtichaut @MAdrianMattocks @matheus-consoli @mental32 @nmccarty @Noah-Kennedy @pard68 @PeytonT @pierreN @Redblueflame @RobbieClarken @RobertoSnap @robjtede @SarthakSingh31 @shekohex @sinato @smmalis37 @steffahn @Stupremee @tamuhey @turboladen @woshilapin @yerke

@rustbot rustbot added the ICEBreaker-Cleanup-Crew Helping to "clean up" bugs with minimal examples and bisections label Nov 19, 2020
@camelid camelid added P-medium Medium priority and removed I-prioritize Issue: Indicates that prioritization has been requested for this issue. labels Dec 11, 2020
@camelid
Copy link
Member

camelid commented Dec 11, 2020

Prioritized as P-medium for now: it seems people are only running into this in compiler docs and it's not catastrophic.

@jackh726
Copy link
Member

Going to close this, since it's been 3 years without an MCVE.

Searching visit_with doesn't have Ty::visit_with as the first result. Searching directly for that though does not result in a 404.

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-mcve Call for participation: This issue has a repro, but needs a Minimal Complete and Verifiable Example ICEBreaker-Cleanup-Crew Helping to "clean up" bugs with minimal examples and bisections P-medium Medium priority 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

7 participants