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.

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

Documentation of Channels could really use an example #14312

Closed
kshyatt opened this issue Dec 7, 2015 · 5 comments
Closed

Documentation of Channels could really use an example #14312

kshyatt opened this issue Dec 7, 2015 · 5 comments
Labels
docs This change adds or pertains to documentation help wanted Indicates that a maintainer wants help on an issue or pull request needs docs Documentation for this change is required parallelism Parallel or distributed computation
Milestone

Comments

@kshyatt
Copy link
Contributor

kshyatt commented Dec 7, 2015

http://docs.julialang.org/en/latest/manual/parallel-computing/#channels

The documentation even references an example file. It would be very nice to have short snippet examples of using put, take, isready, etc. in this section for people who are not familiar with Channels. An example of using the Channel in the for loop would also be great!

@kshyatt kshyatt added docs This change adds or pertains to documentation parallelism Parallel or distributed computation labels Dec 7, 2015
@ViralBShah
Copy link
Member

Cc @amitmurthy

@bryaan
Copy link

bryaan commented Jan 8, 2016

Agreed. I am trying to figure out how to do this.

  for alert in channel
      println("Received Alert: $alert")
  end

Is this correct?

@JeffBezanson JeffBezanson modified the milestones: 0.5.x, 0.5.0 Mar 30, 2016
@kshyatt
Copy link
Contributor Author

kshyatt commented Jul 27, 2016

Bumping this if @amitmurthy or maybe @shashi want to take a run at it? (Or do we think the docs are good enough?)

@tkelman tkelman added the needs docs Documentation for this change is required label Jul 27, 2016
@tkelman
Copy link
Contributor

tkelman commented Jul 27, 2016

Or do we think the docs are good enough?

Channels still don't have any code examples, so no

@StefanKarpinski StefanKarpinski added help wanted Indicates that a maintainer wants help on an issue or pull request and removed help wanted Indicates that a maintainer wants help on an issue or pull request labels Oct 27, 2016
@JeffBezanson
Copy link
Member

Has been fixed; see #17674

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs This change adds or pertains to documentation help wanted Indicates that a maintainer wants help on an issue or pull request needs docs Documentation for this change is required parallelism Parallel or distributed computation
Projects
None yet
Development

No branches or pull requests

6 participants