Skip to content

Commit

Permalink
prepare for 3.6
Browse files Browse the repository at this point in the history
  • Loading branch information
c-cube committed Oct 19, 2021
1 parent 2c7e907 commit b2cff1d
Show file tree
Hide file tree
Showing 8 changed files with 78 additions and 65 deletions.
13 changes: 13 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,18 @@
# Changelog

## 3.6

- rename `CCOpt` to `CCOption` and deprecate `CCOpt`
- add iterator functions to `CCIO`
- `CCOrd`: add `poly`, deprecate `compare`
- add `CCIO.File.walk_iter`
- `CCParse`: heavy refactoring, many new functions
* backtracking by default
* add `slice` and the ability to recurse on them
* expose Position module, add `or_`, `both`, `lookahead`, `U.bool`
* example Sexpr parser, and a test
* example and test of an IRC log parser

## 3.5

- add `CCHash.map` and `CCHash.bytes`
Expand Down
2 changes: 1 addition & 1 deletion containers-data.opam
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
opam-version: "2.0"
version: "3.5"
version: "3.6"
author: "Simon Cruanes"
maintainer: "simon.cruanes.2007@m4x.org"
synopsis: "A set of advanced datatypes for containers"
Expand Down
2 changes: 1 addition & 1 deletion containers-thread.opam
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
opam-version: "2.0"
version: "3.5"
version: "3.6"
author: "Simon Cruanes"
maintainer: "simon.cruanes.2007@m4x.org"
license: "BSD-2-Clause"
Expand Down
2 changes: 1 addition & 1 deletion containers.opam
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
opam-version: "2.0"
name: "containers"
version: "3.5"
version: "3.6"
author: "Simon Cruanes"
maintainer: "simon.cruanes.2007@m4x.org"
license: "BSD-2-Clause"
Expand Down
10 changes: 5 additions & 5 deletions src/core/CCIO.mli
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ val read_chunks_seq : ?size:int -> in_channel -> string Seq.t

val read_chunks_iter : ?size:int -> in_channel -> string iter
(** Read the channel's content into chunks of size at most [size]
@since NEXT_RELEASE *)
@since 3.6 *)

val read_line : in_channel -> string option
(** Read a line from the channel. Returns [None] if the input is terminated.
Expand All @@ -99,7 +99,7 @@ val read_lines_seq : in_channel -> string Seq.t

val read_lines_iter : in_channel -> string iter
(** Read all lines.
@since NEXT_RELEASE *)
@since 3.6 *)

val read_lines_l : in_channel -> string list
(** Read all lines into a list. *)
Expand Down Expand Up @@ -146,7 +146,7 @@ val write_lines : out_channel -> string gen -> unit

val write_lines_iter : out_channel -> string iter -> unit
(** Write every string on the output, followed by "\n".
@since NEXT_RELEASE *)
@since 3.6 *)

val write_lines_seq : out_channel -> string Seq.t -> unit
(** Write every string on the output, followed by "\n".
Expand Down Expand Up @@ -265,7 +265,7 @@ module File : sig

val walk_iter : t -> walk_item iter
(** Like {!walk} but with an imperative iterator.
@since NEXT_RELEASE *)
@since 3.6 *)

val walk_l : t -> walk_item list
(** Like {!walk} but returns a list (therefore it's eager and might
Expand All @@ -274,7 +274,7 @@ module File : sig

val walk_seq : t -> walk_item Seq.t
(** Like {!walk} but returns a Seq
@since NEXT_RELEASE *)
@since 3.6 *)

val show_walk_item : walk_item -> string

Expand Down
2 changes: 1 addition & 1 deletion src/core/CCOption.mli
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
(** Options
This module replaces `CCOpt`.
@since NEXT_RELEASE *)
@since 3.6 *)

type +'a t = 'a option

Expand Down
4 changes: 2 additions & 2 deletions src/core/CCOrd.mli
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,12 @@ type 'a t = 'a -> 'a -> int
val poly : 'a t
(** Polymorphic "magic" comparison. Use with care, as it will fail on
some types.
@since NEXT_RELEASE *)
@since 3.6 *)

val compare : 'a t
[@@deprecated "use CCOrd.poly instead, this name is too general"]
(** Polymorphic "magic" comparison.
@deprecated since NEXT_RELEASE in favor of {!poly}. The reason is that
@deprecated since 3.6 in favor of {!poly}. The reason is that
[compare] is easily shadowed, can shadow other comparators, and is just
generally not very descriptive. *)

Expand Down
Loading

0 comments on commit b2cff1d

Please sign in to comment.