Docstring improvement: free::zip
#633
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
scottmcm
reviewed
Jul 11, 2022
src/free.rs
Outdated
| @@ -105,15 +105,19 @@ pub fn rev<I>(iterable: I) -> iter::Rev<I::IntoIter> | |||
| iterable.into_iter().rev() | |||
| } | |||
|
|
|||
| /// 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.
scottmcm
reviewed
Jul 11, 2022
JoelMon
commented
Jul 11, 2022
src/free.rs
Outdated
| @@ -105,15 +105,19 @@ pub fn rev<I>(iterable: I) -> iter::Rev<I::IntoIter> | |||
| iterable.into_iter().rev() | |||
| } | |||
|
|
|||
| /// 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.
JoelMon
added a commit
to JoelMon/itertools
that referenced
this pull request
Jul 11, 2022
JoelMon
added a commit
to JoelMon/itertools
that referenced
this pull request
Aug 25, 2022
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
requested changes
Aug 25, 2022
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: |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.