Skip to content

Commit 24fdfdf

Browse files
committed
readme
1 parent 5227fb9 commit 24fdfdf

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -411,7 +411,7 @@ module IntMap = CCMap.Make(CCInt);;
411411
```ocaml
412412
# (* conversions using the "iter" type, fast iterators that are
413413
pervasively used in containers. Combinators can be found
414-
in the opam library "sequence". *)
414+
in the opam library "iter". *)
415415
let map : string IntMap.t =
416416
l2
417417
|> List.map (fun x -> x, string_of_int x)
@@ -648,10 +648,13 @@ Some structural types are used throughout the library:
648648

649649
- `gen`: `'a gen = unit -> 'a option` is an iterator type. Many combinators
650650
are defined in the opam library [gen](https://github.com/c-cube/gen)
651-
- `sequence`: `'a sequence = (unit -> 'a) -> unit` is also an iterator type.
651+
- `iter`: `'a iter = (unit -> 'a) -> unit` is also an iterator type, formerly
652+
named `sequence`.
652653
It is easier to define on data structures than `gen`, but it a bit less
653654
powerful. The opam library [iter](https://github.com/c-cube/iter)
654-
can be used to consume and produce values of this type. It was renamed
655+
can be used to consume and produce values of this type.
656+
657+
It was renamed
655658
from `'a sequence` to `'a iter` to distinguish it better from `Core.Sequence`
656659
and the standard `seq`.
657660
- `error`: `'a or_error = ('a, string) result = Error of string | Ok of 'a`

0 commit comments

Comments
 (0)