Skip to content

Add docstrings for StdLib_Bool #7556

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 17, 2025
Merged

Add docstrings for StdLib_Bool #7556

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions runtime/Stdlib_Bool.resi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,28 @@ switch Bool.fromStringExn("notAValidBoolean") {
@deprecated("Use `fromStringOrThrow` instead")
let fromStringExn: string => bool

/**
Compares two booleans, returns an `Ordering.t` value.

## Examples
```rescript
Bool.compare(true, true)->assertEqual(Ordering.equal)
Bool.compare(false, false)->assertEqual(Ordering.equal)
Bool.compare(true, false)->assertEqual(Ordering.greater)
Bool.compare(false, true)->assertEqual(Ordering.less)
```
*/
external compare: (bool, bool) => Stdlib_Ordering.t = "%compare"

/**
Checks if two booleans are equal and have the same value.

## Examples
```rescript
Bool.equal(true, true)->assertEqual(true)
Bool.equal(false, false)->assertEqual(true)
Bool.equal(true, false)->assertEqual(false)
Bool.equal(false, true)->assertEqual(false)
```
*/
external equal: (bool, bool) => bool = "%equal"