in README, a section about incoming breaking changes

This commit is contained in:
Simon Cruanes 2015-09-04 14:12:00 +02:00
parent b9d6e3da5c
commit 290ba2810a
2 changed files with 19 additions and 0 deletions

View file

@ -209,6 +209,23 @@ is not necessarily up-to-date.
There is a QuickCheck-like library called `QCheck` (now in its own repo).
## Incoming (Breaking) Changes
the following breaking changes are likely to occur for the next release (they
can still be discussed, of course):
- moving `containers.lwt` into its own repository and opam package
- moving `containers.misc` into its own repository and opam package (improving the average quality of containers!)
- aliasing and deprecating `CCList.split` (confusion with `List.split`)
already in git (but can be reverted if needed):
- change exceptions in `CCVector`
- change signature of `CCDeque.of_seq` (remove optional argument)
- heavily refactor `CCLinq` in `containers.advanced`. If you use this module,
you will most likely have to change your code (into simpler code, hopefully).
## Build
You will need OCaml >= 4.01.0.

View file

@ -113,6 +113,8 @@ val split : int -> 'a t -> 'a t * 'a t
(** [split n l] returns [l1, l2] such that [l1 @ l2 = l] and
[length l1 = min (length l) n] *)
(* TODO: deprecate and rename split, it already exists in stdlib *)
val last : int -> 'a t -> 'a t
(** [last n l] takes the last [n] elements of [l] (or less if
[l] doesn't have that many elements *)