simon/iter
1
0
Fork 0
mirror of https://github.com/c-cube/iter.git synced 2025-12-05 19:00:31 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

add missing @since

Browse source
This commit is contained in:
Simon Cruanes 2022-01-07 16:57:26 -05:00 • committed by GitHub
parent 84061bcb69
commit 66dec7710b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 8 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
src/Iter.mli
View file

@ -123,12 +123,14 @@ val iteri : (int -> 'a -> unit) -> 'a t -> unit
val for_each : 'a t -> ('a -> unit) -> unit
(** Consume the iterator, passing all its arguments to the function.
[for_each seq f] is the same as [iter f seq], i.e., [iter] with
arguments reversed. *)
arguments reversed.
@since NEXT_RELEASE *)
val for_eachi : 'a t -> (int -> 'a -> unit) -> unit
(** Iterate on elements and their index in the iterator.
[for_eachi seq f] is the same as [iteri f seq], i.e., [iteri] with
arguments reversed. *)
arguments reversed.
@since NEXT_RELEASE *)
val fold : ('a -> 'b -> 'a) -> 'a -> 'b t -> 'a
(** Fold over elements of the iterator, consuming it *)

6
src/IterLabels.mli
View file

@ -91,12 +91,14 @@ val iteri : f:(int -> 'a -> unit) -> 'a t -> unit
val for_each : seq:'a t -> ('a -> unit) -> unit
(** Consume the iterator, passing all its arguments to the function.
[for_each seq f] is the same as [iter f seq], i.e., [iter] with
arguments reversed. *)
arguments reversed.
@since NEXT_RELEASE *)
val for_eachi : seq:'a t -> (int -> 'a -> unit) -> unit
(** Iterate on elements and their index in the iterator.
[for_eachi seq f] is the same as [iteri f seq], i.e., [iteri] with
arguments reversed. *)
arguments reversed.
@since NEXT_RELEASE *)
val fold : f:('a -> 'b -> 'a) -> init:'a -> 'b t -> 'a
(** Fold over elements of the iterator, consuming it *)