-
Notifications
You must be signed in to change notification settings - Fork 14k
Closed
Labels
A-docsArea: Documentation for any part of the project, including the compiler, standard library, and toolsArea: Documentation for any part of the project, including the compiler, standard library, and toolsC-tracking-issueCategory: An issue tracking the progress of sth. like the implementation of an RFCCategory: An issue tracking the progress of sth. like the implementation of an RFCE-help-wantedCall for participation: Help is requested to fix this issue.Call for participation: Help is requested to fix this issue.E-mediumCall for participation: Medium difficulty. Experience needed to fix: Intermediate.Call for participation: Medium difficulty. Experience needed to fix: Intermediate.E-mentorCall for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion.Call for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion.P-mediumMedium priorityMedium priority
Description
Part of #29329
http://doc.rust-lang.org/std/fmt/
Here's what needs to be done to close out this issue:
- the module level docs almost belong in their own issue. These are very old docs written long ago, and while they're good, I have a hunch they could be made way better. Not needed to close this issue.
- all of the traits should say "
Cformatting", whereCis the char, rather than their current boilerplate. Except Write. And Display. -
fmt::Resultneeds an example, showing off theuse std::fmt; fmt::Resultpattern. -
writeshould have itsArgumentssection removed, we don't do this. -
formathas the same issue, and needs more explanation generally. - All of the traits have... I dunno, the wording feels awkward. This doesn't need to be fixed to close this issue, but would be nice.
-
Writeneeds a lot of links. and some examples. -
Argumentsneeds examples, but also a justification of why this is all done this way. -
DebugListshould use the iterator boilerplate language, even though it's not an iterator. Mostly pointing to the docs of the function that creates it. -
DebugMapsame. -
DebugSetsame. -
DebugStructsame. -
DebugTuplesame. -
Errorneeds examples, and specificallyuse std::fmt; fmt::Error -
Formattershould show where it's created, and talk about the details more.
Metadata
Metadata
Assignees
Labels
A-docsArea: Documentation for any part of the project, including the compiler, standard library, and toolsArea: Documentation for any part of the project, including the compiler, standard library, and toolsC-tracking-issueCategory: An issue tracking the progress of sth. like the implementation of an RFCCategory: An issue tracking the progress of sth. like the implementation of an RFCE-help-wantedCall for participation: Help is requested to fix this issue.Call for participation: Help is requested to fix this issue.E-mediumCall for participation: Medium difficulty. Experience needed to fix: Intermediate.Call for participation: Medium difficulty. Experience needed to fix: Intermediate.E-mentorCall for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion.Call for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion.P-mediumMedium priorityMedium priority