Skip to content

Commit

Permalink
Changelog: Add "Breaking Changes" and "Deprecations" sections (#139)
Browse files Browse the repository at this point in the history
  • Loading branch information
curiousleo authored May 20, 2020
1 parent 1c255b7 commit 450d75e
Showing 1 changed file with 20 additions and 1 deletion.
21 changes: 20 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# 1.2

1. Breaking change which mostly maintains backwards compatibility.
1. Breaking change which mostly maintains backwards compatibility, see
"Breaking Changes" below.
2. Support for monadic generators e.g. [mwc-random](https://hackage.haskell.org/package/mwc-random).
3. Monadic adapters for pure generators (providing a uniform monadic
interface to pure and monadic generators).
Expand All @@ -23,6 +24,24 @@
9. [Continuous integration](https://travis-ci.org/github/idontgetoutmuch/random).
10. Fully documented - for more details see the [haddock](https://htmlpreview.github.io/?https://github.com/idontgetoutmuch/random/blob/release-notes/docs/System-Random.html).

### Breaking Changes

Version 1.2 introduces these breaking changes:

* requires `base >= 4.10` (GHC-8.2)
* `StdGen` is no longer an instance of `Read`
* `randomIO` and `randomRIO` where extracted from the `Random` class into
separate functions

In addition, there may be import clashes with new functions, e.g. `uniform` and
`uniformR`.

### Deprecations

Version 1.2 introduces `genWord64`, `genWord32` and similar methods to the
`RandomGen` class. The significantly slower method `next` and its companion
`genRange` are now deprecated.

### Issues Addressed

Issue Number | Description | Comment
Expand Down

0 comments on commit 450d75e

Please sign in to comment.