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
Improved docstrings for free::chain
#634
Conversation
src/free.rs
Outdated
@@ -128,16 +128,25 @@ pub fn zip<I, J>(i: I, j: J) -> Zip<I::IntoIter, J::IntoIter> | |||
i.into_iter().zip(j) | |||
} | |||
|
|||
/// Create an iterator that first iterates `i` and then `j`. | |||
/// `chain()` returns the result of combining the _first_ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fix: As in #633 (comment), this is not just about https://doc.rust-lang.org/nightly/std/primitive.array.htmls, so shouldn't be written this way.
@scottmcm: std::iter::chain this means that this function was also stabilized in std, right? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi there, thanks for this - improvements to documentation is always good!
It would be nice if you could incorporate the suggestions (or refute them with good reason), and sqash your changes into a single commit.
94326f3
to
860f239
Compare
I think I finally got this git squashing, force pushing stuff down. It's about time. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the changes. Could you have a second look there? With the suggested changes, I think we're good to go.
860f239
to
520765c
Compare
@phimuemue, would you be able to take a look at #633 as well? |
Thanks a bunch! bors r+ |
Build succeeded: |
Improved the description of the function and added example.