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

doc: fix mdx for readme

Browse source
This commit is contained in:
Simon Cruanes 2022-02-11 21:14:51 -05:00
parent c5d435848b
commit 01b209b218
No known key found for this signature in database
GPG key ID: 4AC01D0849AA62B6
1 changed files with 7 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -221,7 +221,7 @@ In a toplevel, using ocamlfind:
# #require "containers-data";; # #require "containers-data";;
# CCList.flat_map;; # CCList.flat_map;;
- : ('a -> 'b list) -> 'a list -> 'b list = <fun> - : ('a -> 'b list) -> 'a list -> 'b list = <fun>
# open Containers;; (* optional *) # open Containers (* optional *);;
# List.flat_map ;; # List.flat_map ;;
- : ('a -> 'b list) -> 'a list -> 'b list = <fun> - : ('a -> 'b list) -> 'a list -> 'b list = <fun>
``` ```
@ -359,7 +359,7 @@ the library is loaded, e.g. with:
```ocaml ```ocaml
# #require "containers";; # #require "containers";;
# Format.set_margin 50;; (* for readability here *) # Format.set_margin 50 (* for readability here *);;
- : unit = () - : unit = ()
``` ```
@ -369,7 +369,7 @@ We will start with a few list helpers, then look at other parts of
the library, including printers, maps, etc. the library, including printers, maps, etc.
```ocaml ```ocaml
# (|>) ;; (* quick reminder of this awesome standard operator *) # (|>) (* quick reminder of this awesome standard operator *);;
- : 'a -> ('a -> 'b) -> 'b = <fun> - : 'a -> ('a -> 'b) -> 'b = <fun>
# 10 |> succ;; # 10 |> succ;;
- : int = 11 - : int = 11
@ -412,7 +412,7 @@ module IntMap = CCMap.Make(CCInt);;
|> IntMap.of_iter;; |> IntMap.of_iter;;
val map : string IntMap.t = <abstr> val map : string IntMap.t = <abstr>
# CCList.to_iter;; (* check the type *) # CCList.to_iter (* check the type *);;
- : 'a list -> 'a CCList.iter = <fun> - : 'a list -> 'a CCList.iter = <fun>
# IntMap.of_iter ;; # IntMap.of_iter ;;
- : (int * 'a) CCMap.iter -> 'a IntMap.t = <fun> - : (int * 'a) CCMap.iter -> 'a IntMap.t = <fun>
@ -492,7 +492,7 @@ v = 1, 2, 3, 4, 5, 6, 7, 8, 9, 10
# CCVector.push v 42;; # CCVector.push v 42;;
- : unit = () - : unit = ()
# v;; (* now v is a mutable vector *) # v (* now v is a mutable vector *);;
- : (int, CCVector.rw) CCVector.t = <abstr> - : (int, CCVector.rw) CCVector.t = <abstr>
# (* functional combinators! *) # (* functional combinators! *)
@ -531,7 +531,7 @@ h = [2,4,6,8,10]
val h' : IntHeap.t = <abstr> val h' : IntHeap.t = <abstr>
val x : int = 2 val x : int = 2
# IntHeap.to_list h' ;; (* see, 2 is removed *) # IntHeap.to_list h' (* see, 2 is removed *);;
- : int list = [4; 6; 8; 10] - : int list = [4; 6; 8; 10]
``` ```
@ -614,7 +614,7 @@ A quick example based on purely functional double-ended queues:
```ocaml ```ocaml
# #require "containers-data";; # #require "containers-data";;
# #install_printer CCFQueue.pp;; (* better printing of queues! *) # #install_printer CCFQueue.pp (* better printing of queues! *);;
# let q = CCFQueue.of_list [2;3;4] ;; # let q = CCFQueue.of_list [2;3;4] ;;
val q : int CCFQueue.t = queue {2; 3; 4} val q : int CCFQueue.t = queue {2; 3; 4}