summaryrefslogtreecommitdiff
path: root/stdlib
diff options
context:
space:
mode:
authorDaniel Bünzli <daniel.buenzli@erratique.ch>2018-11-08 17:33:55 +0100
committerAlain Frisch <alain@frisch.fr>2018-11-08 17:33:55 +0100
commitacb0e91ac67e5b905a9d615d936297c4acb1efc0 (patch)
treeeb5e2d4ed0455fdcd31bfc6203167b49020696f8 /stdlib
parentbf78bacb14333bb235a38f148234ed3ff8525807 (diff)
downloadocaml-acb0e91ac67e5b905a9d615d936297c4acb1efc0.tar.gz
Stdlib doc: harmonize heading levels again. (#2142)
Diffstat (limited to 'stdlib')
-rw-r--r--stdlib/array.ml2
-rw-r--r--stdlib/array.mli2
-rw-r--r--stdlib/arrayLabels.mli6
-rw-r--r--stdlib/buffer.ml2
-rw-r--r--stdlib/buffer.mli2
-rw-r--r--stdlib/bytes.ml2
-rw-r--r--stdlib/bytes.mli4
-rw-r--r--stdlib/bytesLabels.mli2
-rw-r--r--stdlib/hashtbl.ml2
-rw-r--r--stdlib/hashtbl.mli2
-rw-r--r--stdlib/list.ml2
-rw-r--r--stdlib/list.mli2
-rw-r--r--stdlib/listLabels.mli2
-rw-r--r--stdlib/map.mli2
-rw-r--r--stdlib/queue.ml2
-rw-r--r--stdlib/queue.mli2
-rw-r--r--stdlib/set.mli2
-rw-r--r--stdlib/stack.ml2
-rw-r--r--stdlib/stack.mli2
-rw-r--r--stdlib/string.ml2
-rw-r--r--stdlib/string.mli2
-rw-r--r--stdlib/stringLabels.mli2
22 files changed, 25 insertions, 25 deletions
diff --git a/stdlib/array.ml b/stdlib/array.ml
index d2feb3747e..a1b9663f1d 100644
--- a/stdlib/array.ml
+++ b/stdlib/array.ml
@@ -306,7 +306,7 @@ let stable_sort cmp a =
let fast_sort = stable_sort
-(** {6 Iterators} *)
+(** {1 Iterators} *)
let to_seq a =
let rec aux i () =
diff --git a/stdlib/array.mli b/stdlib/array.mli
index 1cbe25d0dd..77824b54ad 100644
--- a/stdlib/array.mli
+++ b/stdlib/array.mli
@@ -259,7 +259,7 @@ val fast_sort : ('a -> 'a -> int) -> 'a array -> unit
*)
-(** {6 Iterators} *)
+(** {1 Iterators} *)
val to_seq : 'a array -> 'a Seq.t
(** Iterate on the array, in increasing order. Modifications of the
diff --git a/stdlib/arrayLabels.mli b/stdlib/arrayLabels.mli
index 32d6fd6efe..df84a7d358 100644
--- a/stdlib/arrayLabels.mli
+++ b/stdlib/arrayLabels.mli
@@ -161,7 +161,7 @@ val fold_right : f:('b -> 'a -> 'a) -> 'b array -> init:'a -> 'a
where [n] is the length of the array [a]. *)
-(** {6 Iterators on two arrays} *)
+(** {1 Iterators on two arrays} *)
val iter2 : f:('a -> 'b -> unit) -> 'a array -> 'b array -> unit
@@ -178,7 +178,7 @@ val map2 : f:('a -> 'b -> 'c) -> 'a array -> 'b array -> 'c array
@since 4.05.0 *)
-(** {6 Array scanning} *)
+(** {1 Array scanning} *)
val exists : f:('a -> bool) -> 'a array -> bool
@@ -259,7 +259,7 @@ val fast_sort : cmp:('a -> 'a -> int) -> 'a array -> unit
*)
-(** {6 Iterators} *)
+(** {1 Iterators} *)
val to_seq : 'a array -> 'a Seq.t
(** Iterate on the array, in increasing order
diff --git a/stdlib/buffer.ml b/stdlib/buffer.ml
index c8d69ba759..30601c6e8e 100644
--- a/stdlib/buffer.ml
+++ b/stdlib/buffer.ml
@@ -273,7 +273,7 @@ let truncate b len =
else
b.position <- len
-(** {6 Iterators} *)
+(** {1 Iterators} *)
let to_seq b =
let rec aux i () =
diff --git a/stdlib/buffer.mli b/stdlib/buffer.mli
index 555d541e12..4c381fc473 100644
--- a/stdlib/buffer.mli
+++ b/stdlib/buffer.mli
@@ -158,7 +158,7 @@ val truncate : t -> int -> unit
Raise [Invalid_argument] if [len < 0] or [len > length b].
@since 4.05.0 *)
-(** {6 Iterators} *)
+(** {1 Iterators} *)
val to_seq : t -> char Seq.t
(** Iterate on the buffer, in increasing order.
diff --git a/stdlib/bytes.ml b/stdlib/bytes.ml
index afc7e15a38..ec47178ff5 100644
--- a/stdlib/bytes.ml
+++ b/stdlib/bytes.ml
@@ -330,7 +330,7 @@ let lowercase s = map Char.lowercase s
let capitalize s = apply1 Char.uppercase s
let uncapitalize s = apply1 Char.lowercase s
-(** {6 Iterators} *)
+(** {1 Iterators} *)
let to_seq s =
let rec aux i () =
diff --git a/stdlib/bytes.mli b/stdlib/bytes.mli
index d2c6555503..6ca2029f99 100644
--- a/stdlib/bytes.mli
+++ b/stdlib/bytes.mli
@@ -319,7 +319,7 @@ val equal: t -> t -> bool
(** The equality function for byte sequences.
@since 4.03.0 *)
-(** {3 Unsafe conversions (for advanced users)}
+(** {1:unsafe Unsafe conversions (for advanced users)}
This section describes unsafe, low-level conversion functions
between [bytes] and [string]. They do not copy the internal data;
@@ -448,7 +448,7 @@ let s = Bytes.of_string "hello"
[string] type for this purpose.
*)
-(** {6 Iterators} *)
+(** {1 Iterators} *)
val to_seq : t -> char Seq.t
(** Iterate on the string, in increasing index order. Modifications of the
diff --git a/stdlib/bytesLabels.mli b/stdlib/bytesLabels.mli
index 7de0c72fb6..efe1f383c8 100644
--- a/stdlib/bytesLabels.mli
+++ b/stdlib/bytesLabels.mli
@@ -293,7 +293,7 @@ val equal: t -> t -> bool
(** The equality function for byte sequences.
@since 4.05.0 *)
-(** {6 Iterators} *)
+(** {1 Iterators} *)
val to_seq : t -> char Seq.t
(** Iterate on the string, in increasing index order. Modifications of the
diff --git a/stdlib/hashtbl.ml b/stdlib/hashtbl.ml
index 997263410a..42f79a6ee9 100644
--- a/stdlib/hashtbl.ml
+++ b/stdlib/hashtbl.ml
@@ -354,7 +354,7 @@ let stats h =
max_bucket_length = mbl;
bucket_histogram = histo }
-(** {6 Iterators} *)
+(** {1 Iterators} *)
let to_seq tbl =
(* capture current array, so that even if the table is resized we
diff --git a/stdlib/hashtbl.mli b/stdlib/hashtbl.mli
index 2d9cd6c1b9..216addc678 100644
--- a/stdlib/hashtbl.mli
+++ b/stdlib/hashtbl.mli
@@ -216,7 +216,7 @@ val stats : ('a, 'b) t -> statistics
buckets by size.
@since 4.00.0 *)
-(** {6 Iterators} *)
+(** {1 Iterators} *)
val to_seq : ('a,'b) t -> ('a * 'b) Seq.t
(** Iterate on the whole table, in unspecified order.
diff --git a/stdlib/list.ml b/stdlib/list.ml
index ff05ae3dcc..9d29a9ded3 100644
--- a/stdlib/list.ml
+++ b/stdlib/list.ml
@@ -494,7 +494,7 @@ let rec compare_length_with l n =
compare_length_with l (n-1)
;;
-(** {6 Iterators} *)
+(** {1 Iterators} *)
let to_seq l =
let rec aux l () = match l with
diff --git a/stdlib/list.mli b/stdlib/list.mli
index d14c5e845f..5922480ec5 100644
--- a/stdlib/list.mli
+++ b/stdlib/list.mli
@@ -349,7 +349,7 @@ val merge : ('a -> 'a -> int) -> 'a list -> 'a list -> 'a list
Not tail-recursive (sum of the lengths of the arguments).
*)
-(** {6 Iterators} *)
+(** {1 Iterators} *)
val to_seq : 'a list -> 'a Seq.t
(** Iterate on the list
diff --git a/stdlib/listLabels.mli b/stdlib/listLabels.mli
index 26fc10d370..a664eed263 100644
--- a/stdlib/listLabels.mli
+++ b/stdlib/listLabels.mli
@@ -355,7 +355,7 @@ val merge : cmp:('a -> 'a -> int) -> 'a list -> 'a list -> 'a list
Not tail-recursive (sum of the lengths of the arguments).
*)
-(** {6 Iterators} *)
+(** {1 Iterators} *)
val to_seq : 'a list -> 'a Seq.t
(** Iterate on the list
diff --git a/stdlib/map.mli b/stdlib/map.mli
index 5980bad0f9..24c6047075 100644
--- a/stdlib/map.mli
+++ b/stdlib/map.mli
@@ -306,7 +306,7 @@ module type S =
(** Same as {!Map.S.map}, but the function receives as arguments both the
key and the associated value for each binding of the map. *)
- (** {6 Iterators} *)
+ (** {1 Iterators} *)
val to_seq : 'a t -> (key * 'a) Seq.t
(** Iterate on the whole map, in ascending order
diff --git a/stdlib/queue.ml b/stdlib/queue.ml
index 1de316ce8d..f8d8b25181 100644
--- a/stdlib/queue.ml
+++ b/stdlib/queue.ml
@@ -147,7 +147,7 @@ let transfer q1 q2 =
q2.last <- q1.last;
clear q1
-(** {6 Iterators} *)
+(** {1 Iterators} *)
let to_seq q =
let rec aux c () = match c with
diff --git a/stdlib/queue.mli b/stdlib/queue.mli
index 6b2f8d940f..e5751cc914 100644
--- a/stdlib/queue.mli
+++ b/stdlib/queue.mli
@@ -91,7 +91,7 @@ val transfer : 'a t -> 'a t -> unit
sequence [iter (fun x -> add x q2) q1; clear q1], but runs
in constant time. *)
-(** {6 Iterators} *)
+(** {1 Iterators} *)
val to_seq : 'a t -> 'a Seq.t
(** Iterate on the queue, in front-to-back order.
diff --git a/stdlib/set.mli b/stdlib/set.mli
index 1de4a9b5e6..dd71280940 100644
--- a/stdlib/set.mli
+++ b/stdlib/set.mli
@@ -264,7 +264,7 @@ module type S =
except perhaps for lists with many duplicated elements.
@since 4.02.0 *)
- (** {6 Iterators} *)
+ (** {1 Iterators} *)
val to_seq_from : elt -> t -> elt Seq.t
(** [to_seq_from x s] iterates on a subset of the elements of [s]
diff --git a/stdlib/stack.ml b/stdlib/stack.ml
index 2c92b03471..c46161f053 100644
--- a/stdlib/stack.ml
+++ b/stdlib/stack.ml
@@ -53,7 +53,7 @@ let iter f s = List.iter f s.c
let fold f acc s = List.fold_left f acc s.c
-(** {6 Iterators} *)
+(** {1 Iterators} *)
let to_seq s = List.to_seq s.c
diff --git a/stdlib/stack.mli b/stdlib/stack.mli
index f63f447215..26ea3cc694 100644
--- a/stdlib/stack.mli
+++ b/stdlib/stack.mli
@@ -72,7 +72,7 @@ val fold : ('b -> 'a -> 'b) -> 'b -> 'a t -> 'b
and [xn] the bottom element. The stack is unchanged.
@since 4.03 *)
-(** {6 Iterators} *)
+(** {1 Iterators} *)
val to_seq : 'a t -> 'a Seq.t
(** Iterate on the stack, top to bottom.
diff --git a/stdlib/string.ml b/stdlib/string.ml
index f39273e7dd..2d089205bc 100644
--- a/stdlib/string.ml
+++ b/stdlib/string.ml
@@ -224,7 +224,7 @@ let capitalize s =
let uncapitalize s =
B.uncapitalize (bos s) |> bts
-(** {6 Iterators} *)
+(** {1 Iterators} *)
let to_seq s = bos s |> B.to_seq
diff --git a/stdlib/string.mli b/stdlib/string.mli
index 29bfc7fca5..ed5167620e 100644
--- a/stdlib/string.mli
+++ b/stdlib/string.mli
@@ -333,7 +333,7 @@ val split_on_char: char -> string -> string list
@since 4.04.0
*)
-(** {6 Iterators} *)
+(** {1 Iterators} *)
val to_seq : t -> char Seq.t
(** Iterate on the string, in increasing index order. Modifications of the
diff --git a/stdlib/stringLabels.mli b/stdlib/stringLabels.mli
index 4001707d33..d136a169f3 100644
--- a/stdlib/stringLabels.mli
+++ b/stdlib/stringLabels.mli
@@ -288,7 +288,7 @@ val split_on_char: sep:char -> string -> string list
@since 4.05.0
*)
-(** {6 Iterators} *)
+(** {1 Iterators} *)
val to_seq : t -> char Seq.t
(** Iterate on the string, in increasing index order. Modifications of the