Clarify relationship between Ord and Eq by updating the antisymmetry …

…law (#298) * Clarify relationship between and by updating the antisymmetry law * Update changelog
purescript · Jul 7, 2022 · f411f34 · f411f34
1 parent 32787f4
commit f411f34
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 1 deletion.
diff --git 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
@@ -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