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

Fix invalid primitive's methods link generation in core and alloc crate #89628

Closed
GuillaumeGomez opened this issue Oct 7, 2021 · 4 comments
Closed
Labels
A-intra-doc-links Area: Intra-doc links, the ability to link to items in docs by name C-bug Category: This is a bug. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@GuillaumeGomez
Copy link
Member

There are some broken links when generating primitives' methods using intra-doc links from the core and alloc crate. The list is here. It was introduced in #87073. At the time we merged because the change was really important and far outweighed this problem. But it would be nice to finish it. :)

@GuillaumeGomez GuillaumeGomez added T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. C-bug Category: This is a bug. A-intra-doc-links Area: Intra-doc links, the ability to link to items in docs by name labels Oct 7, 2021
@jyn514
Copy link
Member

jyn514 commented Oct 7, 2021

@GuillaumeGomez this is not a problem we can fix in rustdoc. It's a special case of #74481.

@GuillaumeGomez
Copy link
Member Author

I had in mind something like what you did #87073: provide a link through a markdown file depending whether we were in core/alloc or in std. If we are in a downstream crate, then we provide a "hard" link to the method in std. Having a more generic way to do so would be nice though.

@jyn514
Copy link
Member

jyn514 commented Oct 7, 2021

@GuillaumeGomez that's what broke it in the first place. Relative links can never work for both the original item and the re-export.

@jyn514
Copy link
Member

jyn514 commented Oct 30, 2021

I'm going to close this as a duplicate of #32130, I don't think we need multiple issues tracking the linkcheck exceptions.

@jyn514 jyn514 closed this as completed Oct 30, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-intra-doc-links Area: Intra-doc links, the ability to link to items in docs by name C-bug Category: This is a bug. 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

2 participants