diff --git a/CHANGELOG.md b/CHANGELOG.md index c98cd441..a02052d4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -11,6 +11,7 @@ New features: Bugfixes: Other improvements: +- Documentation: Clarify relationship between `Ord` and `Eq` (#298 by @JamieBallingall) ## [v6.0.0](https://github.com/purescript/purescript-prelude/releases/tag/v6.0.0) - 2022-04-27 diff --git a/src/Data/Ord.purs b/src/Data/Ord.purs index 619347d8..ed699905 100644 --- a/src/Data/Ord.purs +++ b/src/Data/Ord.purs @@ -40,7 +40,7 @@ import Type.Proxy (Proxy(..)) -- | `Ord` instances should satisfy the laws of total orderings: -- | -- | - Reflexivity: `a <= a` --- | - Antisymmetry: if `a <= b` and `b <= a` then `a = b` +-- | - Antisymmetry: if `a <= b` and `b <= a` then `a == b` -- | - Transitivity: if `a <= b` and `b <= c` then `a <= c` -- | -- | **Note:** The `Number` type is not an entirely law abiding member of this