mirror of
https://github.com/c-cube/ocaml-containers.git
synced 2025-12-16 07:46:04 -05:00
Comments tweaks
This commit is contained in:
parent
7c77a5ad41
commit
5b3d3e038d
5 changed files with 12 additions and 12 deletions
|
|
@ -190,7 +190,7 @@ val to_iter : 'a t -> 'a iter
|
|||
@since 2.8 *)
|
||||
|
||||
val to_std_seq : 'a t -> 'a Seq.t
|
||||
(** [to_std_seq a] returns a [Seq.t] of the elements of an array [a].
|
||||
(** [to_std_seq a] returns a [seq] of the elements of an array [a].
|
||||
The input array [a] is shared with the sequence and modification of it will result
|
||||
in modification of the sequence.
|
||||
@since 2.8
|
||||
|
|
|
|||
|
|
@ -196,7 +196,7 @@ val to_iter : 'a t -> 'a iter
|
|||
@since 2.8 *)
|
||||
|
||||
val to_std_seq : 'a t -> 'a Seq.t
|
||||
(** [to_std_seq a] returns a [Seq.t] of the elements of an array [a].
|
||||
(** [to_std_seq a] returns a [seq] of the elements of an array [a].
|
||||
The input array [a] is shared with the sequence and modification of it will result
|
||||
in modification of the sequence.
|
||||
@since 2.8
|
||||
|
|
|
|||
|
|
@ -117,7 +117,7 @@ module type S = sig
|
|||
@since 2.8 *)
|
||||
|
||||
val add_std_seq : t -> elt Seq.t -> t
|
||||
(** [add_std_seq h Seq.t] is like {!add_list}.
|
||||
(** [add_std_seq h seq] is like {!add_list}.
|
||||
@since 2.8 *)
|
||||
|
||||
val of_iter : elt iter -> t
|
||||
|
|
@ -125,7 +125,7 @@ module type S = sig
|
|||
@since 2.8 *)
|
||||
|
||||
val of_std_seq : elt Seq.t -> t
|
||||
(** [of_std_seq Seq.t] builds a heap from a given [Seq.t]. Complexity: [O(n log n)].
|
||||
(** [of_std_seq seq] builds a heap from a given [Seq.t]. Complexity: [O(n log n)].
|
||||
@since 2.8 *)
|
||||
|
||||
val to_iter : t -> elt iter
|
||||
|
|
@ -133,7 +133,7 @@ module type S = sig
|
|||
@since 2.8 *)
|
||||
|
||||
val to_std_seq : t -> elt Seq.t
|
||||
(** [to_std_seq h] returns a [Seq.t] of the elements of the heap [h].
|
||||
(** [to_std_seq h] returns a [seq] of the elements of the heap [h].
|
||||
@since 2.8 *)
|
||||
|
||||
val to_iter_sorted : t -> elt iter
|
||||
|
|
@ -142,7 +142,7 @@ module type S = sig
|
|||
@since 2.8 *)
|
||||
|
||||
val to_std_seq_sorted : t -> elt Seq.t
|
||||
(** [to_std_seq_sorted h ] returns a [Seq.t] by iterating on the elements of [h],
|
||||
(** [to_std_seq_sorted h] returns a [seq] by iterating on the elements of [h],
|
||||
in increasing order.
|
||||
@since 2.8 *)
|
||||
|
||||
|
|
|
|||
|
|
@ -367,12 +367,12 @@ val last : int -> 'a t -> 'a t
|
|||
[l] doesn't have that many elements). *)
|
||||
|
||||
val head_opt : 'a t -> 'a option
|
||||
(** [head_opt l] returns [Some x] (the first element of the list [l]
|
||||
(** [head_opt l] returns [Some x] (the first element of the list [l])
|
||||
or [None] if the list [l] is empty.
|
||||
@since 0.20 *)
|
||||
|
||||
val tail_opt : 'a t -> 'a t option
|
||||
(** [tail_opt l] returns [Some l'] (the given list [l] without its first element),
|
||||
(** [tail_opt l] returns [Some l'] (the given list [l] without its first element)
|
||||
or [None] if the list [l] is empty.
|
||||
@since 2.0 *)
|
||||
|
||||
|
|
@ -754,7 +754,7 @@ val to_iter : 'a t -> 'a iter
|
|||
@since 2.8 *)
|
||||
|
||||
val to_std_seq : 'a t -> 'a Seq.t
|
||||
(** [to_std_seq l] returns a [Seq.t] of the elements of the list [l].
|
||||
(** [to_std_seq l] returns a [seq] of the elements of the list [l].
|
||||
@since 2.8 *)
|
||||
|
||||
val of_iter : 'a iter -> 'a t
|
||||
|
|
@ -763,11 +763,11 @@ val of_iter : 'a iter -> 'a t
|
|||
@since 2.8 *)
|
||||
|
||||
val of_std_seq_rev : 'a Seq.t -> 'a t
|
||||
(** [of_std_seq_rev Seq.t] builds a list from a given [Seq.t], in reverse order.
|
||||
(** [of_std_seq_rev seq] builds a list from a given [seq], in reverse order.
|
||||
@since 2.8 *)
|
||||
|
||||
val of_std_seq : 'a Seq.t -> 'a t
|
||||
(** [of_std_seq Seq.t] builds a list from a given [Seq.t].
|
||||
(** [of_std_seq seq] builds a list from a given [seq].
|
||||
In the result, elements appear in the same order as they did in the source [Seq.t].
|
||||
@since 2.8 *)
|
||||
|
||||
|
|
|
|||
|
|
@ -42,7 +42,7 @@ val to_iter : t -> char iter
|
|||
@since 2.8 *)
|
||||
|
||||
val to_std_seq : t -> char Seq.t
|
||||
(** [to_std_seq s] returns a [Seq.t] of the bytes in [s].
|
||||
(** [to_std_seq s] returns a [seq] of the bytes in [s].
|
||||
@since 2.8
|
||||
*)
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue