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

update doc

Browse source
This commit is contained in:
Simon Cruanes 2015-06-29 16:18:23 +02:00
parent 9f07d976c4
commit bca172a7a8
4 changed files with 9 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
README.md
View file

@ -17,7 +17,7 @@ What is _containers_?
- Several small additional libraries that complement it: - Several small additional libraries that complement it:
* `containers.data` with additional data structures that don't have an * `containers.data` with additional data structures that don't have an
equivalent in the standard library; equivalent in the standard library;
* `containers.io` with utils to handle files and I/O streams; * `containers.io` (deprecated)
* `containers.iter` with list-like and tree-like iterators; * `containers.iter` with list-like and tree-like iterators;
* `containers.string` (in directory `string`) with * `containers.string` (in directory `string`) with
a few packed modules that deal with strings (Levenshtein distance, a few packed modules that deal with strings (Levenshtein distance,
@ -99,6 +99,7 @@ Documentation [here](http://cedeela.fr/~simon/software/containers).
- `CCPrint` (printing combinators) - `CCPrint` (printing combinators)
- `CCHash` (hashing combinators) - `CCHash` (hashing combinators)
- `CCError` (monadic error handling, very useful) - `CCError` (monadic error handling, very useful)
- `CCIO`, basic utilities for IO (channels, files)
### Containers.data ### Containers.data
@ -120,7 +121,8 @@ Documentation [here](http://cedeela.fr/~simon/software/containers).
### Containers.io ### Containers.io
- `CCIO`, basic utilities for IO *deprecated*, `CCIO` is now a core module. You can still install it and
depend on it but it contains no useful module.
### Containers.unix ### Containers.unix

5
doc/intro.txt
View file

@ -33,6 +33,7 @@ CCHash
CCHashtbl CCHashtbl
CCHeap CCHeap
CCInt CCInt
CCIO
CCList CCList
CCMap CCMap
CCOpt CCOpt
@ -80,9 +81,7 @@ CCTrie
{4 Containers.io} {4 Containers.io}
Helpers to perform simple IO (mostly on files) and iterate on channels. {b deprecated} use {!CCIO} directly from the set of core modules.
{!modules: CCIO}
{4 Containers.unix} {4 Containers.unix}

2
src/core/CCIO.ml
View file

@ -26,7 +26,7 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
(** {1 IO Utils} *) (** {1 IO Utils} *)
type 'a gen = unit -> 'a option (** See {!CCGen} *) type 'a gen = unit -> 'a option
let gen_singleton x = let gen_singleton x =
let done_ = ref false in let done_ = ref false in

6
src/core/CCIO.mli
View file

@ -55,14 +55,12 @@ Examples:
@since 0.6 @since 0.6
in 'containers' (rather than 'containers.io') @before NEXT_RELEASE was in 'containers.io', now moved into 'containers'
@since NEXT_RELEASE
*) *)
type 'a gen = unit -> 'a option (** See {!Gen} *) type 'a gen = unit -> 'a option (** See {!Gen} in the gen library *)
(** {2 Input} *) (** {2 Input} *)