Skip to content
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.

Sign up for GitHub

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

Jump to bottom

doc: Documentation examples for parallel iterator methods #420

Closed
alexcrichton opened this issue Sep 6, 2017 · 4 comments
Closed

doc: Documentation examples for parallel iterator methods #420

alexcrichton opened this issue Sep 6, 2017 · 4 comments
Assignees
@cuviper
Labels
documentation help wanted
Milestone
1.0

Comments

@alexcrichton
Copy link

Ideally all methods on the parallel iterator traits should have an example of how they can be used!
@alexcrichton alexcrichton mentioned this issue Sep 6, 2017
Closed
20 tasks
mamuleanu added a commit to mamuleanu/rayon that referenced this issue Oct 29, 2017
@mamuleanu
Add documentation examples for parallel iterator methods
557f2c9 
Closes rayon-rs#420
@mamuleanu mamuleanu mentioned this issue Oct 29, 2017
Merged
mamuleanu added a commit to mamuleanu/rayon that referenced this issue Nov 4, 2017
@mamuleanu
Add documentation examples for parallel iterator methods
913d358 
Closes rayon-rs#420
bors bot added a commit that referenced this issue Nov 6, 2017
@bors
Merge #466
953e0c5 
466: Add documentation examples for parallel iterator methods r=cuviper a=mamuleanu

Closes #420
@bors bors bot closed this as completed in #466 Nov 7, 2017
@cuviper
Copy link
Member

cuviper commented Nov 7, 2017

I'm reopening this per #466 (comment)

@cuviper cuviper reopened this Nov 7, 2017
@nikomatsakis nikomatsakis added this to the 1.0 milestone Jan 4, 2018
@oddg oddg mentioned this issue Jan 20, 2018
Merged
@nikomatsakis
Copy link
Member

Assigning @cuviper to do a sweep over these methods.

@cuviper
Copy link
Member

cuviper commented Jan 24, 2018 •
edited
Loading

Ideally all methods on the parallel iterator traits should have an example of how they can be used!

"traits" plural -- I'm inclined to include all traits in the prelude, but we're missing a lot of examples...

(#512 does add documentation to some of these, but not examples.)

Also, the iter functions are in good shape except for iter::split().

@iwillspeak iwillspeak mentioned this issue Jan 28, 2018
Merged
bors bot added a commit that referenced this issue Feb 1, 2018
@bors
Merge #517
4e60fdf 
517: Add Examples to Documentation r=cuviper a=iwillspeak

Updates the docs for the `ParallelString` and `ParallelSlice` trait to add
examples for each method.

part of #420
bors bot added a commit that referenced this issue Feb 6, 2018
@bors
Merge #511
692bd03 
511: 420 document parallel iterator methods r=nikomatsakis a=oddg

Contribution for closing #420.

There is one method left in the `ParallelIterator` trait that has no example: `opt_len`.
Also the example for `fold_with` might not be necessary.
bors bot added a commit that referenced this issue Feb 7, 2018
@bors
Merge #511
cf02764 
511: 420 document parallel iterator methods r=nikomatsakis a=oddg

Contribution for closing #420.

There is one method left in the `ParallelIterator` trait that has no example: `opt_len`.
Also the example for `fold_with` might not be necessary.
@cuviper cuviper mentioned this issue Feb 7, 2018
Merged
bors bot added a commit that referenced this issue Feb 8, 2018
@bors
Merge #526
176d749 
526: Add examples to more traits r=nikomatsakis a=cuviper

This covers the simpler one-method traits for #420.
This was referenced Feb 12, 2018
Merged
Merged
bors bot added a commit that referenced this issue Feb 14, 2018
@bors
Merge #531
790c968 
531: Add examples to IndexedParallelIterator r=nikomatsakis a=cuviper

cc #420
bors bot added a commit that referenced this issue Feb 14, 2018
@bors
Merge #528 #530
d746e48 
528: Replace coco with crossbeam-deque r=nikomatsakis a=cuviper

These are the changes from @stjepang and @jeehoonkang, replacing and closing #480.  The minimum rustc is *slightly* increased from 1.12 to 1.13 for the transitive requirements.

530: Add examples to par_split_mut and par_chunks_mut r=nikomatsakis a=cuviper

Also add an odd tail to the `par_chunks` example.

cc #420
@cuviper
Copy link
Member

cuviper commented Feb 14, 2018

All checked!

@cuviper cuviper closed this as completed Feb 14, 2018
@cuviper cuviper mentioned this issue Feb 19, 2018
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@cuviper cuviper

Labels
documentation help wanted
Projects
None yet
Milestone
1.0
Development

No branches or pull requests
3 participants
@cuviper @alexcrichton @nikomatsakis