Skip to content

Commit

Permalink
Improve documentation of Lwt_stream
Browse files Browse the repository at this point in the history
Fixes #1005
  • Loading branch information
raphael-proust committed Dec 14, 2023
1 parent 3d640dc commit abee970
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions src/core/lwt_stream.mli
Original file line number Diff line number Diff line change
Expand Up @@ -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}. *)
(** Closes the stream. Any thread currently blocked on a call to
the [push] method fails with {!Lwt_stream.Closed}. *)

method count : int
(** Number of elements in the stream queue. *)

method blocked : bool
(** Is a thread is blocked on {!Lwt_stream.bounded_push.push} ? *)
(** Is a thread is blocked on a call to the [push] method? *)

method closed : bool
(** Is the stream closed ? *)
(** Is the stream closed? *)

method set_reference : 'a. 'a -> unit
(** Set the reference to an external source. *)
Expand Down

0 comments on commit abee970

Please sign in to comment.