Skip to content

Commit

Permalink
fix @SInCE tags
Browse files Browse the repository at this point in the history
  • Loading branch information
c-cube committed Oct 19, 2023
1 parent d37733b commit b8a31b0
Show file tree
Hide file tree
Showing 5 changed files with 12 additions and 12 deletions.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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)
8 changes: 4 additions & 4 deletions src/bb_queue.mli
Original file line number Diff line number Diff line change
Expand Up @@ -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. *)
Expand All @@ -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 *)
2 changes: 1 addition & 1 deletion src/bounded_queue.mli
Original file line number Diff line number Diff line change
Expand Up @@ -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. *)
Expand Down
4 changes: 2 additions & 2 deletions src/fut.mli
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.
Expand Down
8 changes: 4 additions & 4 deletions src/moonpool.mli
Original file line number Diff line number Diff line change
Expand Up @@ -114,23 +114,23 @@ 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

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
Expand Down

0 comments on commit b8a31b0

Please sign in to comment.