Expand std::path::Component documentation.
#34475
Conversation
|
Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @aturon (or someone else) soon. If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes. Please see the contribution instructions for more information. |
| @@ -525,6 +525,26 @@ impl<'a> Hash for PrefixComponent<'a> { | |||
| /// | |||
| /// See the module documentation for an in-depth explanation of components and | |||
| /// their role in the API. | |||
| /// | |||
| /// This `struct` is created from iterating over the [`path::Components`] | |||
There was a problem hiding this comment.
I'm not sure to understand in here. You're talking about the Components struct but this is supposed to be the doc for the Component enum. Any further explanation please? :)
There was a problem hiding this comment.
The only way (that I know) to create a Component struct is by iterating over the Components struct.
There was a problem hiding this comment.
Nevermind. I'll change this to enum later.
There was a problem hiding this comment.
So it was just the wrong word. Ping me once changed then. 😛
Indicate how it gets created and add an example.
|
All good, thanks! @bors: r+ rollup |
|
📌 Commit f1d600c has been approved by |
…eGomez Expand `std::path::Component` documentation. Indicate how it gets created and add an example.
…eGomez Expand `std::path::Component` documentation. Indicate how it gets created and add an example.
…eGomez Expand `std::path::Component` documentation. Indicate how it gets created and add an example.
Indicate how it gets created and add an example.