Skip to content

Commit 61338ed

Browse files
committed
docs(CHANGELOG): prepare for 2.0.0
1 parent ce559c2 commit 61338ed

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

CHANGELOG.markdown

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,30 @@
1+
# [2.0.0](https://github.com/RedPRL/algaeff/compare/1.1.0...2.0.0) (2023-10-31)
2+
3+
This major release has two breaking changes:
4+
5+
1. `Algaeff.{Reader,Sequencer,State,UniqueID}` are now taking a module with a type `t`. Previously, the type is named `elt`, `env`, or `state` depending on the component. Now, it is always named `t`. The benefit is that one can write succinct code for built-in types:
6+
```ocaml
7+
module R = Algaeff.Reader.Make (Bool)
8+
module Sq = Algaeff.Sequencer.Make (Int)
9+
module St = Algaeff.State.Make (Int)
10+
module St = Algaeff.UniqueID.Make (String)
11+
```
12+
To upgrade from the older version of this library, please change the type name (`env`, `elt`, or `state`) in
13+
```ocaml
14+
module R = Algaeff.Reader.Make (struct type env = ... end)
15+
module Sq = Algaeff.Sequencer.Make (struct type elt = ... end)
16+
module St = Algaeff.State.Make (struct type state = ... end)
17+
module U = Algaeff.UniqueID.Make (struct type elt = ... end)
18+
```
19+
to `t` as follows:
20+
```ocaml
21+
module R = Algaeff.Reader.Make (struct type t = ... end)
22+
module Sq = Algaeff.Sequencer.Make (struct type t = ... end)
23+
module St = Algaeff.State.Make (struct type t = ... end)
24+
module U = Algaeff.UniqueID.Make (struct type t = ... end)
25+
```
26+
2. `Algaeff.Unmonad` is removed.
27+
128
# [1.1.0](https://github.com/RedPRL/algaeff/compare/1.0.0...1.1.0) (2023-10-01)
229

330
### Features

0 commit comments

Comments
 (0)