Skip to content

Fix the link in rustdoc.md #143438

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Conversation

makai410
Copy link
Contributor

@makai410 makai410 commented Jul 4, 2025

No description provided.

@rustbot
Copy link
Collaborator

rustbot commented Jul 4, 2025

r? @ehuss

rustbot has assigned @ehuss.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. labels Jul 4, 2025
@ehuss
Copy link
Contributor

ehuss commented Jul 4, 2025

Thanks! However, I don't think the new link is correct. This file is rendered at https://doc.rust-lang.org/nightly/rustdoc.html, and it is trying to link to the Rust Book. However, it is currently going to the older link at https://doc.rust-lang.org/nightly/book/documentation.html.

I think this would either link to book/ch14-02-publishing-to-crates-io.html#making-useful-documentation-comments or rustdoc/index.html.

@GuillaumeGomez do you have a preference?

@GuillaumeGomez
Copy link
Member

If we're talking about working on rustdoc, I'd link to https://rustc-dev-guide.rust-lang.org/rustdoc-internals.html. If it's about using rustdoc, I'd link to https://doc.rust-lang.org/rustdoc/what-is-rustdoc.html.

@ehuss
Copy link
Contributor

ehuss commented Jul 4, 2025

Yea, this is for users. You can see what the old docs looked like at https://doc.rust-lang.org/0.11.0/rustdoc.html.

@rust-log-analyzer

This comment has been minimized.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants