Skip to content

Add description of fold function arguments. #22976

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

Closed
wants to merge 2 commits into from
Closed

Add description of fold function arguments. #22976

wants to merge 2 commits into from

Conversation

hauleth
Copy link
Contributor

@hauleth hauleth commented Mar 2, 2015

Currently I always need to think which one is accumulator and which one is current item. This should improve this.

@rust-highfive
Copy link
Contributor

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @pcwalton (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. 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 CONTRIBUTING.md for more information.

@alexcrichton
Copy link
Member

r? @steveklabnik

@@ -607,20 +607,28 @@ pub trait IteratorExt: Iterator + Sized {
/// Performs a fold operation over the entire iterator, returning the
/// eventual state at the end of the iteration.
///
/// # Arguments
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't currently have any conventions for using Arguments as a top-level thing.

@steveklabnik
Copy link
Member

Thanks @hauleth ! It's true, the order is hard to remember. I'm not entirely sure about the Arguments bit, though the extra descriptions can be helpful for sure, and I'm also not sure about func.

@hauleth
Copy link
Contributor Author

hauleth commented Mar 6, 2015

@steveklabnik reverted "controversial" changes.

@steveklabnik steveklabnik mentioned this pull request Mar 8, 2015
Manishearth added a commit to Manishearth/rust that referenced this pull request Mar 8, 2015
bors added a commit that referenced this pull request Mar 8, 2015
@steveklabnik
Copy link
Member

This landed in #23179. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants