-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
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
Add docs for Channel #7673
Add docs for Channel #7673
Conversation
6e81e9b
to
3f082bd
Compare
Co-Authored-By: j8r <mi@jrei.ch>
Co-Authored-By: j8r <mi@jrei.ch>
Co-Authored-By: j8r <mi@jrei.ch>
Co-Authored-By: j8r <mi@jrei.ch>
Co-Authored-By: j8r <mi@jrei.ch>
Co-Authored-By: j8r <mi@jrei.ch>
Co-Authored-By: j8r <mi@jrei.ch>
Co-Authored-By: j8r <mi@jrei.ch>
Co-Authored-By: j8r <mi@jrei.ch>
Co-Authored-By: j8r <mi@jrei.ch>
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.
Can you add more actual documentation? For example what's a channel? What are they used for? What safety do they entail? What are Buffered and Unbuffered channels? What's their difference and strong/weak points? When will operations block —because even a buffered channel can block.
@ysbaddaden I wish I could but I have not the experience to go into the details, and tell pros and cons of buffered vs unbuffered channels. Mine barely reach |
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.
I think, this is good enough for the start. @j8r do you plan to improve this in the future?
@sdogruyol Maybe, I don't know when I would have enough experience/knowledge with Channels to further improve the documentation. I won't probably the best one for this task. |
Fixes #5801
I'm not very familiar with channels and its concepts, this docs can be improved.