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

std::fmt documentation does not explain the colon #131865

Open
kpreid opened this issue Oct 18, 2024 · 0 comments
Open

std::fmt documentation does not explain the colon #131865

kpreid opened this issue Oct 18, 2024 · 0 comments
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools A-fmt Area: `std::fmt` needs-triage This issue may need triage. Remove it if it has been sufficiently triaged. T-libs Relevant to the library team, which will review and decide on the PR/issue.

Comments

@kpreid
Copy link
Contributor

kpreid commented Oct 18, 2024

Location

https://doc.rust-lang.org/std/fmt/

Summary

The documentation of format strings uses the colon “:” without ever explaining what its role is. To some it will be obvious, but others will benefit from a brief explanation of the general syntax principle: that everything to the left of the “:” is the identifier of the input data, everything to the right is formatting options, and the colon per se does not change anything at all but only introduces the options.

@rustbot label +A-fmt

@kpreid kpreid added the A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools label Oct 18, 2024
@rustbot rustbot added needs-triage This issue may need triage. Remove it if it has been sufficiently triaged. A-fmt Area: `std::fmt` labels Oct 18, 2024
@jieyouxu jieyouxu added the T-libs Relevant to the library team, which will review and decide on the PR/issue. label Oct 18, 2024
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 A-fmt Area: `std::fmt` needs-triage This issue may need triage. Remove it if it has been sufficiently triaged. T-libs Relevant to the library team, which will review and decide on the PR/issue.
Projects
None yet
Development

No branches or pull requests

3 participants