Improve documentation of Lwt_stream #1006
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
A bit lazy, I don't know how to reference methods in the doc markup so I just went for plain english. Suggestions welcome but I'm also ok to merge as is. |
reynir
reviewed
Dec 15, 2023
| @@ -84,17 +84,17 @@ class type ['a] bounded_push = object | |||
| is already blocked on [push], it raises {!Lwt_stream.Full}. *) | |||
|
|
|||
| method close : unit | |||
| (** Closes the stream. Any thread currently blocked on | |||
| {!Lwt_stream.bounded_push.push} fails with {!Lwt_stream.Closed}. *) | |||
There was a problem hiding this comment.
I think maybe it should be {!Lwt_stream.bounded_push#push} but I find it hard to test or find resources for how to cross-reference methods.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #1005