rust-lang/rust

API Docs: path

Closed this issue · 5 comments

steveklabnik commented

Part of #29329

http://doc.rust-lang.org/std/path/

Here's what's needed to close out this issue:

  • Components should use the standard iterator boilerplate.
  • Display needs some more explanation and a link to the display method.
  • Iter should use the standard iterator boilerplate.
  • PrefixComponent needs general expansion and examples
  • StripPrefixError needs a shorter summary and a link to the method it comes from.
  • Component shouldn't say to refer to the module, we should move most of its docs here.
  • Prefix could use more explanation, and is_verbatim needs an example.
mgattozzi commented

@steveklabnik I'd be willing to help further document this module. Are there any trouble spots in particular that could use further clarification or items within the module that could use more documentation or examples?

steveklabnik commented

@mgattozzi things I can see right now:

  1. some stuff could use examples, not just on the individual methods, but also generally
  2. https://doc.rust-lang.org/std/path/struct.Iter.html should link to the method that creates it, see the various iterator structs in std::iter for some boilerplate text.
mgattozzi commented

Alright I'll start working on it this week. I'll link the branch I'll be working on here once I start so anyone can look at the progress, then put in a PR when it's ready.

steveklabnik commented

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

chordowl commented

I'm gonna work on this one!