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

API Docs: fmt #29355

Open
steveklabnik opened this Issue Oct 26, 2015 · 11 comments

Comments

Projects
None yet
6 participants
@steveklabnik
Member

steveklabnik commented Oct 26, 2015

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.
  • DebugStruct 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.

@steveklabnik steveklabnik added the A-docs label Oct 26, 2015

bors added a commit that referenced this issue Apr 29, 2016

steveklabnik added a commit to steveklabnik/rust that referenced this issue May 2, 2016

Manishearth added a commit to Manishearth/rust that referenced this issue May 2, 2016

Manishearth added a commit to Manishearth/rust that referenced this issue May 2, 2016

steveklabnik added a commit to steveklabnik/rust that referenced this issue May 5, 2016

steveklabnik added a commit to steveklabnik/rust that referenced this issue May 5, 2016

steveklabnik added a commit to steveklabnik/rust that referenced this issue May 5, 2016

steveklabnik added a commit to steveklabnik/rust that referenced this issue May 6, 2016

GuillaumeGomez added a commit to GuillaumeGomez/rust that referenced this issue May 7, 2016

Manishearth added a commit to Manishearth/rust that referenced this issue May 8, 2016

Manishearth added a commit to Manishearth/rust that referenced this issue May 9, 2016

Manishearth added a commit to Manishearth/rust that referenced this issue May 9, 2016

steveklabnik added a commit to steveklabnik/rust that referenced this issue May 10, 2016

steveklabnik added a commit to steveklabnik/rust that referenced this issue May 11, 2016

@steveklabnik

This comment has been minimized.

Member

steveklabnik commented Mar 8, 2017

I am happy to mentor anyone who wants to tackle this issue.

@webbm

This comment has been minimized.

webbm commented Mar 24, 2017

@steveklabnik, I would like to work on this.

@steveklabnik

This comment has been minimized.

Member

steveklabnik commented Mar 25, 2017

@webbm awesome, please let me know if you need anything.

@mandeep

This comment has been minimized.

Contributor

mandeep commented Apr 4, 2017

Hi @webbm! Before I start working on some of the items on the checklist I wanted to check with you to see which items are still available so that we don't duplicate effort.

@webbm

This comment has been minimized.

webbm commented Apr 4, 2017

@mandeep, I have done a little of 1, 2, 4, and 5 is in progress. I'm going to create a Trello board to keep track of my own progress. Should I add all these as tasks and add you?

@mandeep

This comment has been minimized.

Contributor

mandeep commented Apr 7, 2017

@webbm No need for Trello just yet. I'll work on item 3 this weekend and report back.

@rthomas

This comment has been minimized.

Contributor

rthomas commented Jun 22, 2017

@steveklabnik If no one is looking at this I'll jump in for write.

@steveklabnik

This comment has been minimized.

Member

steveklabnik commented Jun 22, 2017

@rthomas I'm not aware of any active work right now, that'd be great!

rthomas added a commit to rthomas/rust that referenced this issue Jun 22, 2017

Update docs for std::fmt::format rust-lang#29355.
This rewords and removes the `Arguments` section from the docs for
fmt::format.

r? @steveklabnik

rthomas added a commit to rthomas/rust that referenced this issue Jun 22, 2017

Update docs for std::fmt::format rust-lang#29355.
This rewords and removes the `Arguments` section from the docs for
fmt::format.

r? @steveklabnik

rthomas added a commit to rthomas/rust that referenced this issue Jun 22, 2017

Add docs for Debug* structs. rust-lang#29355
This adds docs for the Debug* structs as well as examples from the
Formatter::debug_* methods, so that a user knows how to construct them.

I added these examples as the builders module is not public and hence
the debug_*_new() functions are not available to a user.

r? @steveklabnik
@rthomas

This comment has been minimized.

Contributor

rthomas commented Jun 22, 2017

I have sent PRs for write format and the Debug* entries - 4, 5, 8, 9, 10, 11, 12.

rthomas added a commit to rthomas/rust that referenced this issue Jun 22, 2017

Update docs on Error struct. rust-lang#29355
This adds a pretty contrived example of the usage of fmt::Error. I am
very open to suggestions for a better one.

I have also highlighted the fmt::Error vs std::error::Error.

r? @steveklabnik
@rthomas

This comment has been minimized.

Contributor

rthomas commented Jun 22, 2017

Looking at the last one (Formatter) although I am struggling to see where this is actually instantiated...

Mark-Simulacrum added a commit to Mark-Simulacrum/rust that referenced this issue Jun 28, 2017

Rollup merge of rust-lang#42831 - rthomas:master, r=QuietMisdreavus
Update docs for fmt::write.

rust-lang#29355

I reworded it slightly to make it more clear that the function only take
two arguments - the output and the Arguments struct that can be
generated from the format_args! macro.

r? @steveklabnik

Mark-Simulacrum added a commit to Mark-Simulacrum/rust that referenced this issue Jun 28, 2017

Rollup merge of rust-lang#42832 - rthomas:doc-fmt, r=steveklabnik
Update docs for std::fmt::format rust-lang#29355.

This rewords and removes the `Arguments` section from the docs for
fmt::format.

r? @steveklabnik

frewsxcv added a commit to frewsxcv/rust that referenced this issue Jun 29, 2017

Rollup merge of rust-lang#42831 - rthomas:master, r=QuietMisdreavus
Update docs for fmt::write.

rust-lang#29355

I reworded it slightly to make it more clear that the function only take
two arguments - the output and the Arguments struct that can be
generated from the format_args! macro.

r? @steveklabnik

frewsxcv added a commit to frewsxcv/rust that referenced this issue Jun 29, 2017

Rollup merge of rust-lang#42832 - rthomas:doc-fmt, r=steveklabnik
Update docs for std::fmt::format rust-lang#29355.

This rewords and removes the `Arguments` section from the docs for
fmt::format.

r? @steveklabnik

arielb1 added a commit to arielb1/rust that referenced this issue Jun 29, 2017

Rollup merge of rust-lang#42831 - rthomas:master, r=QuietMisdreavus
Update docs for fmt::write.

rust-lang#29355

I reworded it slightly to make it more clear that the function only take
two arguments - the output and the Arguments struct that can be
generated from the format_args! macro.

r? @steveklabnik

arielb1 added a commit to arielb1/rust that referenced this issue Jun 29, 2017

Rollup merge of rust-lang#42832 - rthomas:doc-fmt, r=steveklabnik
Update docs for std::fmt::format rust-lang#29355.

This rewords and removes the `Arguments` section from the docs for
fmt::format.

r? @steveklabnik

rthomas added a commit to rthomas/rust that referenced this issue Jul 2, 2017

Add docs for Debug* structs. rust-lang#29355
This adds docs for the Debug* structs as well as examples from the
Formatter::debug_* methods, so that a user knows how to construct them.

I added these examples as the builders module is not public and hence
the debug_*_new() functions are not available to a user.

r? @steveklabnik

Review comments.

Mainly adding in the links for all of the structs and functions.

Remove rust tag on code blocks.

bors added a commit that referenced this issue Jul 3, 2017

Auto merge of #42836 - rthomas:29355-debug, r=GuillaumeGomez
Update docs for Debug* structs. #29355

This adds docs for the Debug* structs as well as examples from the
Formatter::debug_* methods, so that a user knows how to construct them.

I added these examples as the builders module is not public and hence
the debug_*_new() functions are not available to a user.

r? @steveklabnik

Mark-Simulacrum added a commit to Mark-Simulacrum/rust that referenced this issue Jul 4, 2017

Rollup merge of rust-lang#42836 - rthomas:29355-debug, r=GuillaumeGomez
Update docs for Debug* structs. rust-lang#29355

This adds docs for the Debug* structs as well as examples from the
Formatter::debug_* methods, so that a user knows how to construct them.

I added these examples as the builders module is not public and hence
the debug_*_new() functions are not available to a user.

r? @steveklabnik

rthomas added a commit to rthomas/rust that referenced this issue Jul 13, 2017

Update docs on Error struct. rust-lang#29355
This adds a pretty contrived example of the usage of fmt::Error. I am
very open to suggestions for a better one.

I have also highlighted the fmt::Error vs std::error::Error.

r? @steveklabnik

gaurikholkar added a commit to gaurikholkar/rust that referenced this issue Jul 15, 2017

Add docs for Debug* structs. rust-lang#29355
This adds docs for the Debug* structs as well as examples from the
Formatter::debug_* methods, so that a user knows how to construct them.

I added these examples as the builders module is not public and hence
the debug_*_new() functions are not available to a user.

r? @steveklabnik

Review comments.

Mainly adding in the links for all of the structs and functions.

Remove rust tag on code blocks.

Mark-Simulacrum added a commit to Mark-Simulacrum/rust that referenced this issue Jul 18, 2017

Rollup merge of rust-lang#42837 - rthomas:29355-error, r=steveklabnik
Update docs on Error struct. rust-lang#29355

This adds a pretty contrived example of the usage of fmt::Error. I am
very open to suggestions for a better one.

I have also highlighted the fmt::Error vs std::error::Error.

r? @steveklabnik

mattico added a commit to mattico/rust that referenced this issue Jul 29, 2017

Update docs on Error struct. rust-lang#29355
This adds a pretty contrived example of the usage of fmt::Error. I am
very open to suggestions for a better one.

I have also highlighted the fmt::Error vs std::error::Error.

r? @steveklabnik

brennie added a commit to brennie/rust that referenced this issue Oct 5, 2017

brennie added a commit to brennie/rust that referenced this issue Oct 5, 2017

kennytm added a commit to kennytm/rust that referenced this issue Oct 8, 2017

Rollup merge of rust-lang#45042 - brennie:brennie/fmt-trait-summaries…
…, r=steveklabnik

Update trait summaries for std::fmt

This patch is part of rust-lang#29355.

r? @steveklabnik

Badel2 added a commit to Badel2/rust that referenced this issue Oct 12, 2017

@mehdishojaei

This comment has been minimized.

mehdishojaei commented Oct 24, 2018

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

+1

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