Skip to content

Broken doc links for standard library formatting macros #137519

Closed
@eegli

Description

@eegli

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.

Metadata

Metadata

Assignees

Labels

A-docsArea: Documentation for any part of the project, including the compiler, standard library, and toolsT-libsRelevant to the library team, which will review and decide on the PR/issue.

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions