fix @since tags

This commit is contained in:
Simon Cruanes 2023-10-19 11:08:28 -04:00
parent d37733b5bd
commit b8a31b088f
No known key found for this signature in database
GPG key ID: EBFFF6F283F3A2B4
5 changed files with 12 additions and 12 deletions

View file

@ -45,4 +45,4 @@ VERSION=$(shell awk '/^version:/ {print $$2}' moonpool.opam)
update_next_tag: update_next_tag:
@echo "update version to $(VERSION)..." @echo "update version to $(VERSION)..."
sed -i "s/NEXT_VERSION/$(VERSION)/g" $(wildcard src/**/*.ml) $(wildcard src/**/*.mli) sed -i "s/NEXT_VERSION/$(VERSION)/g" $(wildcard src/**/*.ml) $(wildcard src/**/*.mli)
sed -i "s/NEXT_RELEASE/$(VERSION)/g" $(wildcard src/**/*.ml) $(wildcard src/**/*.mli) sed -i "s/NEXT_RELEASE/$(VERSION)/g" $(wildcard src/*.ml) $(wildcard src/**/*.ml) $(wildcard src/*.mli) $(wildcard src/**/*.mli)

View file

@ -60,7 +60,7 @@ val transfer : 'a t -> 'a Queue.t -> unit
with Bb_queue.Closed -> () with Bb_queue.Closed -> ()
]} ]}
@since NEXT_RELEASE *) @since 0.4 *)
val close : _ t -> unit val close : _ t -> unit
(** Close the queue, meaning there won't be any more [push] allowed. *) (** Close the queue, meaning there won't be any more [push] allowed. *)
@ -71,12 +71,12 @@ type 'a iter = ('a -> unit) -> unit
val to_iter : 'a t -> 'a iter val to_iter : 'a t -> 'a iter
(** [to_iter q] returns an iterator over all items in the queue. (** [to_iter q] returns an iterator over all items in the queue.
This might not terminate if [q] is never closed. This might not terminate if [q] is never closed.
@since NEXT_RELEASE *) @since 0.4 *)
val to_gen : 'a t -> 'a gen val to_gen : 'a t -> 'a gen
(** [to_gen q] returns a generator from the queue. (** [to_gen q] returns a generator from the queue.
@since NEXT_RELEASE *) @since 0.4 *)
val to_seq : 'a t -> 'a Seq.t val to_seq : 'a t -> 'a Seq.t
(** [to_gen q] returns a (transient) sequence from the queue. (** [to_gen q] returns a (transient) sequence from the queue.
@since NEXT_RELEASE *) @since 0.4 *)

View file

@ -11,7 +11,7 @@
Whenever the queue is full, means that producer(s) will have to Whenever the queue is full, means that producer(s) will have to
wait before pushing new work. wait before pushing new work.
@since NEXT_RELEASE *) @since 0.4 *)
type 'a t type 'a t
(** A bounded queue. *) (** A bounded queue. *)

View file

@ -89,7 +89,7 @@ val reify_error : 'a t -> 'a or_error t
(** [reify_error fut] turns a failing future into a non-failing (** [reify_error fut] turns a failing future into a non-failing
one that contain [Error (exn, bt)]. A non-failing future one that contain [Error (exn, bt)]. A non-failing future
returning [x] is turned into [Ok x] returning [x] is turned into [Ok x]
@since NEXT_RELEASE *) @since 0.4 *)
val map : ?on:Runner.t -> f:('a -> 'b) -> 'a t -> 'b t val map : ?on:Runner.t -> f:('a -> 'b) -> 'a t -> 'b t
(** [map ?on ~f fut] returns a new future [fut2] that resolves (** [map ?on ~f fut] returns a new future [fut2] that resolves
@ -109,7 +109,7 @@ val bind_reify_error : ?on:Runner.t -> f:('a or_error -> 'b t) -> 'a t -> 'b t
and resolves like the future [f (Error (exn, bt))] and resolves like the future [f (Error (exn, bt))]
if [fut] fails with [exn] and backtrace [bt]. if [fut] fails with [exn] and backtrace [bt].
@param on if provided, [f] runs on the given runner @param on if provided, [f] runs on the given runner
@since NEXT_RELEASE *) @since 0.4 *)
val join : ?on:Runner.t -> 'a t t -> 'a t val join : ?on:Runner.t -> 'a t t -> 'a t
(** [join fut] is [fut >>= Fun.id]. It joins the inner layer of the future. (** [join fut] is [fut >>= Fun.id]. It joins the inner layer of the future.

View file

@ -114,7 +114,7 @@ module Blocking_queue : sig
with Bb_queue.Closed -> () with Bb_queue.Closed -> ()
]} ]}
@since NEXT_RELEASE *) @since 0.4 *)
type 'a gen = unit -> 'a option type 'a gen = unit -> 'a option
type 'a iter = ('a -> unit) -> unit type 'a iter = ('a -> unit) -> unit
@ -122,15 +122,15 @@ module Blocking_queue : sig
val to_iter : 'a t -> 'a iter val to_iter : 'a t -> 'a iter
(** [to_iter q] returns an iterator over all items in the queue. (** [to_iter q] returns an iterator over all items in the queue.
This might not terminate if [q] is never closed. This might not terminate if [q] is never closed.
@since NEXT_RELEASE *) @since 0.4 *)
val to_gen : 'a t -> 'a gen val to_gen : 'a t -> 'a gen
(** [to_gen q] returns a generator from the queue. (** [to_gen q] returns a generator from the queue.
@since NEXT_RELEASE *) @since 0.4 *)
val to_seq : 'a t -> 'a Seq.t val to_seq : 'a t -> 'a Seq.t
(** [to_gen q] returns a (transient) sequence from the queue. (** [to_gen q] returns a (transient) sequence from the queue.
@since NEXT_RELEASE *) @since 0.4 *)
end end
module Bounded_queue = Bounded_queue module Bounded_queue = Bounded_queue