Tidy changelog

haskell-effectful · Sep 5, 2024 · 2b12ee0 · 2b12ee0
1 parent 06cfe1d
commit 2b12ee0
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 2 deletions.
diff --git a/effectful-core/CHANGELOG.md b/effectful-core/CHANGELOG.md
@@ -8,6 +8,9 @@
   `Effectful.Labeled.Writer`.
 * Add `throwErrorWith` and `throwError_` to `Effectful.Error.Static` and
   `Effectful.Error.Dynamic`.
+* Fix a bug in `stateM` and `modifyM` of thread local `State` effect that
+  might've caused dropped state updates
+  ([#237](https://github.com/haskell-effectful/effectful/issues/237)).
 * **Breaking changes**:
   - `localSeqLend`, `localLend`, `localSeqBorrow` and `localBorrow` now take a
     list of effects instead of a single one.
@@ -16,8 +19,8 @@
     `throwError_` for them.
   - `ThrowError` operation from the dynamic version of the `Error` effect was
     replaced with `ThrowErrorWith`.
-  - `stateEnv` and `modifyEnv` now take pure modification functions. Use a
-    combination of `getEnv` and `putEnv` for forward compatibility.
+  - `stateEnv` and `modifyEnv` now take pure modification functions. If you rely
+    on their old forms, switch to a combination of `getEnv` and `putEnv`.
 
 # effectful-core-2.3.1.0 (2024-06-07)
 * Drop support for GHC 8.8.

diff --git a/effectful/CHANGELOG.md b/effectful/CHANGELOG.md
@@ -9,6 +9,9 @@
 * Add `throwErrorWith` and `throwError_` to `Effectful.Error.Static` and
   `Effectful.Error.Dynamic`.
 * Add `Effectful.Prim.IORef`.
+* Fix a bug in `stateM` and `modifyM` of thread local `State` effect that
+  might've caused dropped state updates
+  ([#237](https://github.com/haskell-effectful/effectful/issues/237)).
 * **Breaking changes**:
   - `localSeqLend`, `localLend`, `localSeqBorrow` and `localBorrow` now take a
     list of effects instead of a single one.
@@ -17,6 +20,8 @@
     `throwError_` for them.
   - `ThrowError` operation from the dynamic version of the `Error` effect was
     replaced with `ThrowErrorWith`.
+  - `stateEnv` and `modifyEnv` now take pure modification functions. If you rely
+    on their old forms, switch to a combination of `getEnv` and `putEnv`.
 
 # effectful-2.3.1.0 (2024-06-07)
 * Drop support for GHC 8.8.