From 290ba2810aabf3368681387288b7c65c98727486 Mon Sep 17 00:00:00 2001 From: Simon Cruanes Date: Fri, 4 Sep 2015 14:12:00 +0200 Subject: [PATCH] in `README`, a section about incoming breaking changes --- README.md | 17 +++++++++++++++++ src/core/CCList.mli | 2 ++ 2 files changed, 19 insertions(+) diff --git a/README.md b/README.md index 88c39414..f233e217 100644 --- a/README.md +++ b/README.md @@ -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. diff --git a/src/core/CCList.mli b/src/core/CCList.mli index 06cb20db..3cd47a94 100644 --- a/src/core/CCList.mli +++ b/src/core/CCList.mli @@ -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 *)