chore(doc): adapt module docstring for the index page

src/core/CCArray.mli

@@ -1,7 +1,6 @@
-
 (* This file is free software, part of containers. See file "license" for more details. *)
 
-(** {1 Array utils} *)
+(** Array utils *)
 
 type 'a iter = ('a -> unit) -> unit
 (** Fast internal iterator.
@@ -18,7 +17,7 @@ type 'a printer = Format.formatter -> 'a -> unit
 include module type of CCShimsArray_
 
 val empty : 'a t
-(** [empty] is the empty array, physically equal to [||]. *)
+(** [empty] is the empty array, physically equal to [[||]]. *)
 
 val equal : 'a equal -> 'a t equal
 (** [equal eq a1 a2] is [true] if the lengths of [a1] and [a2] are the same

src/core/CCArrayLabels.mli

@@ -1,6 +1,6 @@
 (* This file is free software, part of containers. See file "license" for more details. *)
 
-(** {1 Array utils} *)
+(** Array utils (Labeled version of {!CCArray}) *)
 
 type 'a iter = ('a -> unit) -> unit
 (** Fast internal iterator.

src/core/CCBool.mli

@@ -1,6 +1,6 @@
 (* This file is free software, part of containers. See file "license" for more details. *)
 
-(** {1 Basic Bool functions} *)
+(** Basic Bool functions *)
 
 type t = bool
 

src/core/CCCanonical_sexp.mli

@@ -1,7 +1,7 @@
 
 (* This file is free software, part of containers. See file "license" for more details. *)
 
-(** {1 Canonical S-expressions}
+(** Canonical S-expressions
 
     See {{: https://en.wikipedia.org/wiki/Canonical_S-expressions} wikipedia}.
     These S-expressions are binary safe.

src/core/CCChar.mli

@@ -1,6 +1,6 @@
 (* This file is free software, part of containers. See file "license" for more details. *)
 
-(** {1 Utils around char}
+(** Utils around char
 
     @since 0.14 *)
 

src/core/CCEither.mli

@@ -1,6 +1,6 @@
 (* This file is free software, part of containers. See file "license" for more details. *)
 
-(** {1 Either Monad}
+(** Either Monad
 
     Module that is compatible with Either form OCaml 4.12 but can be use with any
     ocaml version compatible with container

src/core/CCEqual.mli

@@ -3,7 +3,7 @@
 
 (* This file is free software, part of containers. See file "license" for more details. *)
 
-(** {1 Equality Combinators} *)
+(** Equality Combinators *)
 
 (** @since 1.2 *)
 

src/core/CCEqualLabels.mli

@@ -1,7 +1,7 @@
 
 (* This file is free software, part of containers. See file "license" for more details. *)
 
-(** {1 Equality Combinators} *)
+(** Equality Combinators (Labeled version of {!CCEqual}) *)
 
 (** @since 1.2 *)
 

src/core/CCFloat.mli

@@ -1,7 +1,7 @@
 
 (* This file is free software, part of containers. See file "license" for more details. *)
 
-(** {1 Basic operations on floating-point numbers}
+(** Basic operations on floating-point numbers
     @since 0.6.1 *)
 
 open CCShims_

src/core/CCFormat.mli

@@ -1,7 +1,7 @@
 
 (* This file is free software, part of containers. See file "license" for more details. *)
 
-(** {1 Helpers for Format}
+(** Helpers for Format
 
     @since 0.8 *)
 

src/core/CCFun.mli

@@ -1,7 +1,7 @@
 
 (* This file is free software, part of containers. See file "license" for more details. *)
 
-(** {1 Basic Functions} *)
+(** Basic operations on Functions *)
 
 include module type of CCShimsFun_
 

src/core/CCHash.mli

@@ -1,7 +1,7 @@
 
 (* This file is free software, part of containers. See file "license" for more details. *)
 
-(** {1 Hash combinators}
+(** Hash combinators
 
     The API of this module is stable as per semantic versioning, like the
     rest of containers. However the exact implementation of hashing function

src/core/CCHashtbl.mli

@@ -1,7 +1,7 @@
 
 (* This file is free software, part of containers. See file "license" for more details. *)
 
-(** {1 Extension to the standard Hashtbl}
+(** Extension to the standard Hashtbl
 
     @since 0.4 *)
 

src/core/CCHeap.mli

@@ -1,7 +1,7 @@
 
 (* This file is free software, part of containers. See file "license" for more details. *)
 
-(** {1 Leftist Heaps}
+(** Leftist Heaps
 
     Implementation following Okasaki's book. *)
 

src/core/CCIO.mli

@@ -1,6 +1,6 @@
 (* This file is free software, part of containers. See file "license" for more details. *)
 
-(** {1 IO Utils}
+(** 1 IO Utils
 
     Simple utilities to deal with basic Input/Output tasks in a resource-safe
     way. For advanced IO tasks, the user is advised to use something

src/core/CCInt.mli

@@ -1,7 +1,7 @@
 
 (* This file is free software, part of containers. See file "license" for more details. *)
 
-(** {1 Basic Int functions} *)
+(** Basic Int functions *)
 
 include module type of CCShimsInt_
 

src/core/CCInt32.mli

@@ -1,8 +1,6 @@
 (* This file is free software, part of containers. See file "license" for more details. *)
 
-(** {1 Int32}
-
-    Helpers for 32-bit integers.
+(** Helpers for 32-bit integers.
 
     This module provides operations on the type int32 of signed 32-bit integers.
     Unlike the built-in int type, the type int32 is guaranteed to be exactly

src/core/CCInt64.mli

@@ -1,8 +1,6 @@
 (* This file is free software, part of containers. See file "license" for more details. *)
 
-(** {1 Int64}
-
-    Helpers for 64-bit integers.
+(** Helpers for 64-bit integers.
 
     This module provides operations on the type int64 of signed 64-bit integers.
     Unlike the built-in int type, the type int64 is guaranteed to be exactly

src/core/CCList.mli

@@ -1,7 +1,7 @@
 
 (* This file is free software, part of containers. See file "license" for more details. *)
 
-(** {1 Complements to list} *)
+(** Complements to List *)
 
 type 'a iter = ('a -> unit) -> unit
 (** Fast internal iterator.

src/core/CCListLabels.mli

@@ -1,7 +1,7 @@
 
 (* This file is free software, part of containers. See file "license" for more details. *)
 
-(** {1 Complements to list} *)
+(** Complements to ListLabels *)
 
 type 'a iter = ('a -> unit) -> unit
 (** Fast internal iterator.

src/core/CCMap.mli

@@ -1,7 +1,7 @@
 
 (* This file is free software, part of containers. See file "license" for more details. *)
 
-(** {1 Extensions of Standard Map}
+(** Extensions of Standard Map
 
     Provide useful functions and iterators on [Map.S]
     @since 0.5 *)

src/core/CCNativeint.mli

@@ -1,8 +1,6 @@
 (* This file is free software, part of containers. See file "license" for more details. *)
 
-(** {1 Nativeint}
-
-    Helpers for processor-native integers
+(** Helpers for processor-native integers
 
     This module provides operations on the type [nativeint] of signed 32-bit integers 
     (on 32-bit platforms) or signed 64-bit integers (on 64-bit platforms). 

src/core/CCOpt.mli

@@ -1,4 +1,4 @@
-(** Option module
+(** Previous Option module
     @deprecated use `CCOption` instead. *)
 
 [@@@ocaml.deprecated "use CCOption instead"]

src/core/CCOption.mli

@@ -1,6 +1,6 @@
 (* This file is free software, part of containers. See file "license" for more details. *)
 
-(** Options
+(** Basic operations on the option type.
 
    This module replaces `CCOpt`.
    @since 3.6 *)

src/core/CCOrd.mli

@@ -1,7 +1,8 @@
+(** Order combinators *)
 
 (* This file is free software, part of containers. See file "license" for more details. *)
 
-(** {1 Comparisons} *)
+(** {2 Comparisons} *)
 
 type 'a t = 'a -> 'a -> int
 (** Comparison (total ordering) between two elements, that returns an int. *)

src/core/CCPair.mli

@@ -1,7 +1,7 @@
 
 (* This file is free software, part of containers. See file "license" for more details. *)
 
-(** {1 Tuple Functions} *)
+(** Tuple Functions *)
 
 type ('a,'b) t = ('a * 'b)
 

src/core/CCParse.mli

@@ -1,7 +1,7 @@
 
 (* This file is free software. See file "license" for more details. *)
 
-(** {1 Very Simple Parser Combinators}
+(** Very Simple Parser Combinators
 
     These combinators can be used to write very simple parsers, for example
     to extract data from a line-oriented file, or as a replacement to {!Scanf}.

src/core/CCRandom.mli

@@ -1,7 +1,7 @@
 
 (* This file is free software, part of containers. See file "license" for more details. *)
 
-(** {1 Random Generators} *)
+(** Random Generators *)
 
 include module type of struct include Random end
 (** {{: https://caml.inria.fr/pub/docs/manual-ocaml/libref/Random.html} Documentation for the standard Random module}*)

src/core/CCRef.mli

@@ -1,7 +1,7 @@
 
 (* This file is free software, part of containers. See file "license" for more details. *)
 
-(** {1 References}
+(** Helpers for references
     @since 0.9 *)
 
 type 'a printer = Format.formatter -> 'a -> unit

src/core/CCResult.mli

@@ -1,6 +1,6 @@
 (* This file is free software, part of containers. See file "license" for more details. *)
 
-(** {1 Error Monad}
+(** Error Monad
 
     Uses the new "result" type from OCaml 4.03.
 

src/core/CCSeq.mli

@@ -1,7 +1,7 @@
 
 (* This file is free software, part of containers. See file "license" for more details. *)
 
-(** {1 Helpers for the standard {b Seq} type}
+(** Helpers for the standard {b Seq} type
 
     See {{: https://github.com/c-cube/oseq/} oseq} for a richer API.
 *)

src/core/CCSet.mli

@@ -1,7 +1,7 @@
 
 (* This file is free software, part of containers. See file "license" for more details. *)
 
-(** {1 Wrapper around Set}
+(** Wrapper around Set
 
     @since 0.9 *)
 

src/core/CCSexp.mli

@@ -1,6 +1,6 @@
 (* This file is free software, part of containers. See file "license" for more details. *)
 
-(** {1 Handling S-expressions}
+(** Handling S-expressions
 
     @since 3.0 moved into containers-core, previously in [containers.sexp]
 *)

src/core/CCString.mli

@@ -1,7 +1,7 @@
 
 (* This file is free software, part of containers. See file "license" for more details. *)
 
-(** {1 Basic String Utils} *)
+(** Basic String Utils *)
 
 type 'a iter = ('a -> unit) -> unit
 (** Fast internal iterator.

src/core/CCStringLabels.mli

@@ -1,7 +1,7 @@
 
 (* This file is free software, part of containers. See file "license" for more details. *)
 
-(** {1 Basic String Utils} *)
+(** Basic String Utils (Labeled version of {!CCString}) *)
 
 type 'a iter = ('a -> unit) -> unit
 (** Fast internal iterator.

src/core/CCUtf8_string.mli

@@ -1,5 +1,5 @@
 
-(** {1 Unicode String, in UTF8} *)
+(** Unicode String, in UTF8 *)
 
 (** A unicode string represented by a utf8 bytestring. This representation
     is convenient for manipulating normal OCaml strings that are encoded

src/core/CCVector.mli

@@ -1,6 +1,6 @@
 (* This file is free software, part of containers. See file "license" for more details. *)
 
-(** {1 Growable, mutable vector} *)
+(** Growable, mutable vector *)
 
 type ro = [`RO]
 type rw = [`RW]

src/core/containers.ml

@@ -1,7 +1,7 @@
 
 (* This file is free software, part of containers. See file "license" for more details. *)
 
-(** {1 Drop-In replacement to Stdlib} *)
+(** Drop-In replacement to Stdlib *)
 
 module Array = CCArray
 module Bool = CCBool

src/core/containersLabels.ml

@@ -1,7 +1,7 @@
 
 (* This file is free software, part of containers. See file "license" for more details. *)
 
-(** {1 Drop-In replacement to Stdlib} *)
+(** Drop-In replacement to Stdlib *)
 
 module Array = CCArrayLabels
 module Bool = CCBool

src/data/CCBV.mli

@@ -1,7 +1,7 @@
 
 (* This file is free software, part of containers. See file "license" for more details. *)
 
-(** {2 Imperative Bitvectors}
+(** Imperative Bitvectors
 
     {b BREAKING CHANGES} since 1.2:
     size is now stored along with the bitvector. Some functions have

src/data/CCBijection.mli

@@ -1,6 +1,6 @@
 (* This file is free software, part of containers. See file "license" for more details. *)
 
-(** {1 Bijection}
+(** Functor to build a bijection
     Represents 1-to-1 mappings between two types. Each element from the "left"
     is mapped to one "right" value, and conversely.
 

src/data/CCBitField.mli

@@ -1,9 +1,9 @@
 (* This file is free software, part of containers. See file "license" for more details. *)
 
-(** {1 Bit Field}
+(** Efficient Bit Field for up to 31 or 61 fiels
 
     This module defines efficient bitfields
-    up to 30 or 62 bits (depending on the architecture) in
+    up to 31 or 61 bits (depending on the architecture) in
     a relatively type-safe way.
 
     {[

src/data/CCCache.mli

@@ -1,7 +1,7 @@
 
 (* This file is free software, part of containers. See file "license" for more details. *)
 
-(** {1 Caches}
+(** Caches Utils
 
     Particularly useful for memoization. See {!with_cache} and {!with_cache_rec}
     for more details.

src/data/CCDeque.mli

@@ -1,6 +1,6 @@
 (* This file is free software, part of containers. See file "license" for more details. *)
 
-(** {1 Imperative deque}
+(** Imperative deque
 
     This structure provides fast access to its front and back elements,
     with O(1) operations. *)

src/data/CCFQueue.mli

@@ -1,7 +1,7 @@
 
 (* This file is free software, part of containers. See file "license" for more details. *)
 
-(** {1 Functional queues} *)
+(** Functional queues *)
 
 type 'a iter = ('a -> unit) -> unit
 type 'a equal = 'a -> 'a -> bool

src/data/CCFun_vec.mli

@@ -1,6 +1,6 @@
 (* This file is free software, part of containers. See file "license" for more details. *)
 
-(** {1 Functional Vectors} *)
+(** Functional Vectors *)
 
 (** Tree with a large branching factor for logarithmic operations with
     a low multiplicative factor.

src/data/CCGraph.mli

@@ -1,7 +1,7 @@
 
 (* This file is free software, part of containers. See file "license" for more details. *)
 
-(** {1 Simple Graph Interface}
+(** Simple Graph Interface
 
     A collections of algorithms on (mostly read-only) graph structures.
     The user provides her own graph structure as a [('v, 'e) CCGraph.t],

src/data/CCHashSet.mli

@@ -1,6 +1,6 @@
 (* This file is free software, part of containers. See file "license" for more details. *)
 
-(** {1 Mutable Set}
+(** Mutable Set
 
     {b status: unstable}
 

src/data/CCHashTrie.mli

@@ -1,6 +1,6 @@
 (* This file is free software, part of containers. See file "license" for more details. *)
 
-(** {1 Hash Tries}
+(** Hash Tries
 
     Trie indexed by the hash of the keys, where the branching factor is fixed.
     The goal is to have a quite efficient functional structure with fast

src/data/CCHet.mli

@@ -1,7 +1,7 @@
 
 (* This file is free software, part of containers. See file "license" for more details. *)
 
-(** {1 Associative containers with Heterogeneous Values}
+(** Associative containers with Heterogeneous Values
 
     This is similar to {!CCMixtbl}, but the injection is directly used as
     a key.

src/data/CCImmutArray.mli

@@ -1,7 +1,7 @@
 
 (* This file is free software, part of containers. See file "license" for more details. *)
 
-(** {1 Immutable Arrays}
+(** Immutable Arrays
 
     Purely functional use of arrays. Update is costly, but reads are very fast.
     Sadly, it is not possible to make this type covariant without using black

src/data/CCIntMap.mli

@@ -1,7 +1,7 @@
 
 (* This file is free software, part of containers. See file "license" for more details. *)
 
-(** {1 Map specialized for Int keys}
+(** Map specialized for Int keys
 
     {b status: stable}
     @since 0.10 *)

src/data/CCKTree.mli

@@ -1,6 +1,6 @@
 (* This file is free software, part of containers. See file "license" for more details. *)
 
-(** {1 Lazy Tree Structure}
+(** Lazy Tree Structure
     This structure can be used to represent trees and directed
     graphs (as infinite trees) in a lazy fashion. Like {!CCKList}, it
     is a structural type. *)

src/data/CCLazy_list.mli

@@ -1,7 +1,7 @@
 
 (* This file is free software, part of containers. See file "license" for more details. *)
 
-(** {1 Lazy List}
+(** Lazy List
 
     @since 0.17 *)
 

src/data/CCMixmap.mli

@@ -1,7 +1,7 @@
 
 (* This file is free software, part of containers. See file "license" for more details. *)
 
-(** {1 Maps with Heterogeneous Values}
+(** Maps with Heterogeneous Values
 
     {b status: experimental}
 

src/data/CCMixset.mli

@@ -1,7 +1,7 @@
 
 (* This file is free software, part of containers. See file "license" for more details. *)
 
-(** {1 Set of Heterogeneous Values}
+(** Set of Heterogeneous Values
 
     {[
       let k1 : int key = newkey () in

src/data/CCMixtbl.mli

@@ -1,7 +1,7 @@
 
 (* This file is free software, part of containers. See file "license" for more details. *)
 
-(** {1 Hash Table with Heterogeneous Keys}
+(** Hash Table with Heterogeneous Keys
 
     From https://github.com/mjambon/mixtbl (thanks to him).
     Example:

src/data/CCMultiMap.mli

@@ -1,6 +1,6 @@
 (* This file is free software, part of containers. See file "license" for more details. *)
 
-(** {1 Multimap} *)
+(** Map that can map key to several values *)
 
 type 'a iter = ('a -> unit) -> unit
 

src/data/CCMultiSet.mli

@@ -1,7 +1,7 @@
 
 (* This file is free software, part of containers. See file "license" for more details. *)
 
-(** {1 Multiset} *)
+(** Multiset *)
 
 type 'a iter = ('a -> unit) -> unit
 

src/data/CCMutHeap.mli

@@ -2,7 +2,7 @@
    As such it is under the Apache 2 License.
 *)
 
-(** {1 Mutable Heaps}
+(** Mutable Heaps
 
     The classic binary heap in a vector.
 

src/data/CCPersistentArray.mli

@@ -24,7 +24,7 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *)
 
 
-(** {1 Persistent Arrays}
+(** Persistent Arrays
 
     From the paper by Jean-Christophe Filliâtre,
     "A persistent Union-Find data structure", see

src/data/CCPersistentHashtbl.mli

@@ -1,7 +1,7 @@
 
 (* This file is free software, part of containers. See file "license" for more details. *)
 
-(** {1 Persistent hash-table on top of OCaml's hashtables}
+(** Persistent hash-table on top of OCaml's hashtables
 
     Almost as efficient as the regular Hashtbl type, but with a persistent
     interface (rewinding changes to get back in the past history). This is

src/data/CCRAL.mli

@@ -1,6 +1,6 @@
 (* This file is free software, part of containers. See file "license" for more details. *)
 
-(** {1 Random-Access Lists}
+(** Random-Access Lists
 
     This is an OCaml implementation of Okasaki's paper
     "Purely Functional Random Access Lists". It defines a list-like data

src/data/CCRingBuffer.mli

@@ -3,7 +3,7 @@
 
 (* Copyright (C) 2015 Simon Cruanes, Carmelo Piccione *)
 
-(** {1 Circular Buffer (Deque)}
+(** Circular Buffer (Deque)
 
     Useful for IO, or as a bounded-size alternative to {!Queue} when
     batch operations are needed.

src/data/CCSimple_queue.mli

@@ -1,7 +1,7 @@
 
 (* This file is free software, part of containers. See file "license" for more details. *)
 
-(** {1 Functional queues (fifo)} *)
+(** Functional queues (fifo) *)
 
 (** Simple implementation of functional queues
     @since 1.3 *)

src/data/CCTrie.mli

@@ -1,7 +1,7 @@
 
 (* This file is free software, part of containers. See file "license" for more details. *)
 
-(** {1 Prefix Tree} *)
+(** Prefix Tree *)
 
 type 'a iter = ('a -> unit) -> unit
 type 'a ktree = unit -> [`Nil | `Node of 'a * 'a ktree list]

src/data/CCWBTree.mli

@@ -1,6 +1,6 @@
 (* This file is free software, part of containers. See file "license" for more details. *)
 
-(** {1 Weight-Balanced Tree}
+(** Weight-Balanced Tree
 
     {b status: experimental}
 

src/data/CCZipper.mli

@@ -1,7 +1,7 @@
 
 (* This file is free software, part of containers. See file "license" for more details. *)
 
-(** {1 List Zipper}
+(** List Zipper
 
     @since 1.0 *)