Skip to content

API Docs: fmt #29355

Closed
Closed
@steveklabnik

Description

@steveklabnik
Member

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 "C formatting", where C is the char, rather than their current boilerplate. Except Write. And Display.
    • fmt::Result needs an example, showing off the use std::fmt; fmt::Result pattern.
    • write should have its Arguments section removed, we don't do this.
    • format has 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.
    • Write needs a lot of links. and some examples.
    • Arguments needs examples, but also a justification of why this is all done this way.
    • DebugList should use the iterator boilerplate language, even though it's not an iterator. Mostly pointing to the docs of the function that creates it.
    • DebugMap same.
    • DebugSet same.
    • DebugTuple same.
    • Error needs examples, and specifically use std::fmt; fmt::Error
    • Formatter should show where it's created, and talk about the details more.

Activity

added a commit that references this issue on May 2, 2016

Rollup merge of rust-lang#33129 - GuillaumeGomez:fmt_doc, r=steveklabnik

added a commit that references this issue on May 7, 2016

Rollup merge of rust-lang#33129 - GuillaumeGomez:fmt_doc, r=steveklabnik

added 3 commits that reference this issue on May 8, 2016

Rollup merge of rust-lang#33129 - GuillaumeGomez:fmt_doc, r=steveklabnik

Rollup merge of rust-lang#33129 - GuillaumeGomez:fmt_doc, r=steveklabnik

Rollup merge of rust-lang#33129 - GuillaumeGomez:fmt_doc, r=steveklabnik

31 remaining items

added a commit that references this issue on Jul 4, 2017

Rollup merge of rust-lang#42836 - rthomas:29355-debug, r=GuillaumeGomez

added a commit that references this issue on Jul 18, 2017

Rollup merge of rust-lang#42837 - rthomas:29355-error, r=steveklabnik

added
C-tracking-issueCategory: An issue tracking the progress of sth. like the implementation of an RFC
on Jul 24, 2017
added a commit that references this issue on Oct 8, 2017

Rollup merge of rust-lang#45042 - brennie:brennie/fmt-trait-summaries…

mahdi-shojaee

mahdi-shojaee commented on Oct 24, 2018

@mahdi-shojaee
  • Formatter should show where it's created, and talk about the details more.

+1

steveklabnik

steveklabnik commented on Jan 8, 2019

@steveklabnik
MemberAuthor

I'm going to send in a PR to help Formatter; after that, all of this is done enough. The module docs are still very huge, but I don't have concrete suggestions at this time. Thank you everyone!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    A-docsArea: 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 RFCE-help-wantedCall for participation: Help is requested to fix this issue.E-mediumCall 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.P-mediumMedium priority

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

      Development

      No branches or pull requests

        Participants

        @steveklabnik@rthomas@webbm@mahdi-shojaee@Mark-Simulacrum

        Issue actions

          API Docs: fmt · Issue #29355 · rust-lang/rust