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

Broken doc links for standard library formatting macros #137519

Closed
eegli opened this issue Feb 24, 2025 · 1 comment · Fixed by #137538
Closed

Broken doc links for standard library formatting macros #137519

eegli opened this issue Feb 24, 2025 · 1 comment · Fixed by #137538
Assignees
Labels
A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools T-libs Relevant to the library team, which will review and decide on the PR/issue.

Comments

@eegli
Copy link

eegli commented Feb 24, 2025

Location

library/std/src/macros.rs

Summary

In library/std/src/macros.rs, the macros print, println, eprint, eprintln all contain the following doc comment:

  • /// See [the formatting documentation in std::fmt](../std/fmt/index.html)

Which resolves to a broken link: https://doc.rust-lang.org/stable/std/std/fmt/index.html.

Doc comments should be adjusted to:

  • /// See [the formatting documentation in std::fmt](../fmt/index.html)

Which would point to the correct online documentation https://doc.rust-lang.org/stable/std/fmt/index.html.

Steps to reproduce: In VSCode, use any of the above macros, hover over the symbol name and click the (broken) link in the popup.

@eegli eegli added the A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools label Feb 24, 2025
@rustbot rustbot added the needs-triage This issue may need triage. Remove it if it has been sufficiently triaged. label Feb 24, 2025
@tapanprakasht
Copy link
Contributor

@rustbot claim

@jieyouxu jieyouxu added T-libs Relevant to the library 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 26, 2025
@bors bors closed this as completed in c29a29e Mar 16, 2025
rust-timer added a commit to rust-lang-ci/rust that referenced this issue Mar 16, 2025
Rollup merge of rust-lang#137538 - tapanprakasht:fix-doc-path, r=thomcc

fix doc path in std::fmt macro

fixes rust-lang#137519
github-actions bot pushed a commit to model-checking/verify-rust-std that referenced this issue Mar 19, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools T-libs Relevant to the library team, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants