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 should be able to reference libstd in intra-doc links in libcore #121436

Closed
clarfonthey opened this issue Feb 22, 2024 · 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

@clarfonthey
Copy link
Contributor

This is something that came up in #112136.

Essentially, because we want to #[doc(inline)] the CString type in its parent module, we actually can't use hard-coded relative links and must use intra-doc links. However, we also can't do intra-doc links in libcore that reference libstd.

I think that especially since doc tests can reference libstd in libcore, we should also be able to intra-doc link libstd in libcore.

This also will probably enable us to get rid of the remaining hard-coded, non-intra-doc-links in libcore.

@rustbot rustbot added the needs-triage This issue may need triage. Remove it if it has been sufficiently triaged. label Feb 22, 2024
@clarfonthey
Copy link
Contributor Author

clarfonthey commented Feb 22, 2024

@rustbot +T-rustdoc

EDIT: :(

@Urgau
Copy link
Member

Urgau commented Feb 22, 2024

@rustbot labels +T-rustdoc +C-bug +A-intra-doc-links -needs-triage

@rustbot rustbot added 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. and removed needs-triage This issue may need triage. Remove it if it has been sufficiently triaged. labels Feb 22, 2024
@ehuss
Copy link
Contributor

ehuss commented Feb 22, 2024

Is this issue much different from #74481?

@fmease
Copy link
Member

fmease commented Feb 22, 2024

Ah, I was just about to link to that issue ^^. Closing as duplicate of #74481.

@fmease fmease closed this as not planned Won't fix, can't repro, duplicate, stale Feb 22, 2024
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

5 participants