From e22c29c27f9fc51e9b0c58ed844041937cca9aad Mon Sep 17 00:00:00 2001 From: Simon Cruanes Date: Tue, 31 Mar 2015 15:52:30 +0200 Subject: [PATCH] doc --- README.md | 6 +++++- _oasis | 4 ++-- doc/intro.txt | 6 ++++++ src/core/CCList.mli | 2 +- 4 files changed, 14 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 2dc0a6ed..de8f5e25 100644 --- a/README.md +++ b/README.md @@ -45,7 +45,7 @@ See [this file](https://github.com/c-cube/ocaml-containers/blob/master/CHANGELOG ## Finding help - the [github wiki](https://github.com/c-cube/ocaml-containers/wiki) -- the IRC channel (`##ocaml-containers` on Freenode) +- on IRC, ask `companion_cube` on `#ocaml` ## Use @@ -109,6 +109,10 @@ Documentation [here](http://cedeela.fr/~simon/software/containers). - `CCIO`, basic utilities for IO +### Containers.unix + +- `CCUnix`, utils for `Unix` + ### Containers.sexp A small S-expression library. diff --git a/_oasis b/_oasis index 63b91e3d..0a671601 100644 --- a/_oasis +++ b/_oasis @@ -152,7 +152,7 @@ Document containers Title: Containers docs Type: ocamlbuild (0.3) BuildTools+: ocamldoc - Build$: flag(docs) && flag(advanced) && flag(bigarray) && flag(lwt) && flag(misc) + Build$: flag(docs) && flag(advanced) && flag(bigarray) && flag(lwt) && flag(misc) && flag(unix) Install: true XOCamlbuildPath: . XOCamlbuildExtraArgs: @@ -160,7 +160,7 @@ Document containers XOCamlbuildLibraries: containers, containers.misc, containers.iter, containers.data, containers.string, containers.bigarray, - containers.advanced, containers.io, containers.sexp, + containers.advanced, containers.io, containers.unix, containers.sexp, containers.lwt Executable run_benchs diff --git a/doc/intro.txt b/doc/intro.txt index 3db1fe94..42f0f3c6 100644 --- a/doc/intro.txt +++ b/doc/intro.txt @@ -83,6 +83,12 @@ Helpers to perform simple IO (mostly on files) and iterate on channels. {!modules: CCIO} +{4 Containers.unix} + +Helpers that depend on {!Unix}, e.g. to spawn sub-processes. + +{!modules: CCUnix} + {4 Containers.sexp} A small S-expression library. The interface is relatively unstable, but diff --git a/src/core/CCList.mli b/src/core/CCList.mli index 5fd0eb7a..75f29f13 100644 --- a/src/core/CCList.mli +++ b/src/core/CCList.mli @@ -132,7 +132,7 @@ val uniq_succ : ?eq:('a -> 'a -> bool) -> 'a list -> 'a list (** [uniq_succ l] removes duplicate elements that occur one next to the other. Examples: [uniq_succ [1;2;1] = [1;2;1]] - [uniq_succ [1;1;2] = [1;2] + [uniq_succ [1;1;2] = [1;2]] @since NEXT_RELEASE *) (** {2 Indices} *)