From b8a31b088f6ba55f73f4e493883efab08aa2d986 Mon Sep 17 00:00:00 2001 From: Simon Cruanes Date: Thu, 19 Oct 2023 11:08:28 -0400 Subject: [PATCH] fix @since tags --- Makefile | 2 +- src/bb_queue.mli | 8 ++++---- src/bounded_queue.mli | 2 +- src/fut.mli | 4 ++-- src/moonpool.mli | 8 ++++---- 5 files changed, 12 insertions(+), 12 deletions(-) diff --git a/Makefile b/Makefile index 0b61b159..a7308673 100644 --- a/Makefile +++ b/Makefile @@ -45,4 +45,4 @@ VERSION=$(shell awk '/^version:/ {print $$2}' moonpool.opam) update_next_tag: @echo "update version to $(VERSION)..." 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) diff --git a/src/bb_queue.mli b/src/bb_queue.mli index b4a1e584..ba4d0fc5 100644 --- a/src/bb_queue.mli +++ b/src/bb_queue.mli @@ -60,7 +60,7 @@ val transfer : 'a t -> 'a Queue.t -> unit with Bb_queue.Closed -> () ]} - @since NEXT_RELEASE *) + @since 0.4 *) val close : _ t -> unit (** 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 (** [to_iter q] returns an iterator over all items in the queue. This might not terminate if [q] is never closed. - @since NEXT_RELEASE *) + @since 0.4 *) val to_gen : 'a t -> 'a gen (** [to_gen q] returns a generator from the queue. - @since NEXT_RELEASE *) + @since 0.4 *) val to_seq : 'a t -> 'a Seq.t (** [to_gen q] returns a (transient) sequence from the queue. - @since NEXT_RELEASE *) + @since 0.4 *) diff --git a/src/bounded_queue.mli b/src/bounded_queue.mli index 85aea884..c5d46df6 100644 --- a/src/bounded_queue.mli +++ b/src/bounded_queue.mli @@ -11,7 +11,7 @@ Whenever the queue is full, means that producer(s) will have to wait before pushing new work. - @since NEXT_RELEASE *) + @since 0.4 *) type 'a t (** A bounded queue. *) diff --git a/src/fut.mli b/src/fut.mli index f5dc5013..944a9525 100644 --- a/src/fut.mli +++ b/src/fut.mli @@ -89,7 +89,7 @@ val reify_error : 'a t -> 'a or_error t (** [reify_error fut] turns a failing future into a non-failing one that contain [Error (exn, bt)]. A non-failing future 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 (** [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))] if [fut] fails with [exn] and backtrace [bt]. @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 (** [join fut] is [fut >>= Fun.id]. It joins the inner layer of the future. diff --git a/src/moonpool.mli b/src/moonpool.mli index 438f9727..1d300665 100644 --- a/src/moonpool.mli +++ b/src/moonpool.mli @@ -114,7 +114,7 @@ module Blocking_queue : sig with Bb_queue.Closed -> () ]} - @since NEXT_RELEASE *) + @since 0.4 *) type 'a gen = unit -> 'a option type 'a iter = ('a -> unit) -> unit @@ -122,15 +122,15 @@ module Blocking_queue : sig val to_iter : 'a t -> 'a iter (** [to_iter q] returns an iterator over all items in the queue. This might not terminate if [q] is never closed. - @since NEXT_RELEASE *) + @since 0.4 *) val to_gen : 'a t -> 'a gen (** [to_gen q] returns a generator from the queue. - @since NEXT_RELEASE *) + @since 0.4 *) val to_seq : 'a t -> 'a Seq.t (** [to_gen q] returns a (transient) sequence from the queue. - @since NEXT_RELEASE *) + @since 0.4 *) end module Bounded_queue = Bounded_queue