Docstring improvement: free::zip
#633
Conversation
src/free.rs
Outdated
| } | ||
|
|
||
| /// Iterate `i` and `j` in lock step. | ||
| /// `zip()` returns a new array where each element is a tuple consisting |
There was a problem hiding this comment.
fix: This returns an iterator, not an array, so I think the text needs to be updated.
Also, remember that the first paragraph shows in https://docs.rs/itertools/latest/itertools/index.html#functions, so it's important to have a short description of it first. A more detailed explanation of what it does it better as a separate paragraph.
There was a problem hiding this comment.
I went ahead and fixed the error and also made the first sentence short.
src/free.rs
Outdated
| } | ||
|
|
||
| /// Iterate `i` and `j` in lock step. | ||
| /// `zip()` returns a new array where each element is a tuple consisting |
There was a problem hiding this comment.
I went ahead and fixed the error and also made the first sentence short.
The free::zip function had a short explanation. I went ahead and fleshed it out a bit. I also placed the code example under the `## Example` subheading. Aslo, fixed errors in PR rust-itertools#633
JoelMon
force-pushed
the
zip_docstring_improve
branch
from
f4213f5 to
9f37cb1
Compare
JoelMon
changed the title
zip
|
I'm going to inline the variables so that it's easier to understand. |
JoelMon
force-pushed
the
zip_docstring_improve
branch
from
9f37cb1 to
47f468d
Compare
phimuemue
left a comment
phimuemue
left a comment
There was a problem hiding this comment.
Hi there, thanks for this. I suggest keeping things simple, and rely on the redirection to std.
Added example and link to std::iter::zip
JoelMon
force-pushed
the
zip_docstring_improve
branch
from
5d35c25 to
4276476
Compare
|
Thank you. bors r+ |
|
Build succeeded: |
4 participants
The
free::zipfunction had a short explanation. I went ahead and fleshed it out a bit.I also placed the code example under the
## Examplesubheading.