mirror of
https://github.com/c-cube/ocaml-containers.git
synced 2025-12-06 03:05:28 -05:00
update doc
This commit is contained in:
parent
9f07d976c4
commit
bca172a7a8
4 changed files with 9 additions and 10 deletions
|
|
@ -17,7 +17,7 @@ What is _containers_?
|
|||
- Several small additional libraries that complement it:
|
||||
* `containers.data` with additional data structures that don't have an
|
||||
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.string` (in directory `string`) with
|
||||
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)
|
||||
- `CCHash` (hashing combinators)
|
||||
- `CCError` (monadic error handling, very useful)
|
||||
- `CCIO`, basic utilities for IO (channels, files)
|
||||
|
||||
### Containers.data
|
||||
|
||||
|
|
@ -120,7 +121,8 @@ Documentation [here](http://cedeela.fr/~simon/software/containers).
|
|||
|
||||
### 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
|
||||
|
||||
|
|
|
|||
|
|
@ -33,6 +33,7 @@ CCHash
|
|||
CCHashtbl
|
||||
CCHeap
|
||||
CCInt
|
||||
CCIO
|
||||
CCList
|
||||
CCMap
|
||||
CCOpt
|
||||
|
|
@ -80,9 +81,7 @@ CCTrie
|
|||
|
||||
{4 Containers.io}
|
||||
|
||||
Helpers to perform simple IO (mostly on files) and iterate on channels.
|
||||
|
||||
{!modules: CCIO}
|
||||
{b deprecated} use {!CCIO} directly from the set of core modules.
|
||||
|
||||
{4 Containers.unix}
|
||||
|
||||
|
|
|
|||
|
|
@ -26,7 +26,7 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|||
|
||||
(** {1 IO Utils} *)
|
||||
|
||||
type 'a gen = unit -> 'a option (** See {!CCGen} *)
|
||||
type 'a gen = unit -> 'a option
|
||||
|
||||
let gen_singleton x =
|
||||
let done_ = ref false in
|
||||
|
|
|
|||
|
|
@ -55,14 +55,12 @@ Examples:
|
|||
|
||||
@since 0.6
|
||||
|
||||
in 'containers' (rather than 'containers.io')
|
||||
|
||||
@since NEXT_RELEASE
|
||||
@before NEXT_RELEASE was in 'containers.io', now moved into 'containers'
|
||||
|
||||
*)
|
||||
|
||||
|
||||
type 'a gen = unit -> 'a option (** See {!Gen} *)
|
||||
type 'a gen = unit -> 'a option (** See {!Gen} in the gen library *)
|
||||
|
||||
(** {2 Input} *)
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue