Skip to content

Commit 8c89c29

Browse files
committed
Doc update for unsafeCompare export
1 parent 60c6bc9 commit 8c89c29

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

docs/Prelude.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -975,4 +975,9 @@ instance showArray :: (Show a) => Show (Array a)
975975
instance showOrdering :: Show Ordering
976976
```
977977

978+
#### `unsafeCompare`
978979

980+
``` purescript
981+
unsafeCompare :: forall a. a -> a -> Ordering
982+
```
983+
The `unsafeCompare` function is mainly intended for module writers supporting native types via the FFI, and not for general comparisons.

0 commit comments

Comments
 (0)