From abee970b7601115cdd1c8764773122f5a79829a9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rapha=C3=ABl=20Proust?= Date: Thu, 14 Dec 2023 10:52:29 +0100 Subject: [PATCH] Improve documentation of Lwt_stream Fixes #1005 --- src/core/lwt_stream.mli | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/core/lwt_stream.mli b/src/core/lwt_stream.mli index 11e9a8472..4f74483cf 100644 --- a/src/core/lwt_stream.mli +++ b/src/core/lwt_stream.mli @@ -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. *)