Refactored GreaterThanOrEquals, added documentation
This commit is contained in:
parent
8ea2ddd21d
commit
63d202bad2
2 changed files with 50 additions and 11 deletions
34
docs/greater_than_or_equals.md
Normal file
34
docs/greater_than_or_equals.md
Normal file
|
@ -0,0 +1,34 @@
|
|||
# greater_than_or_equals
|
||||
|
||||
Returns true if the first argument is greater than or equal to the second argument.
|
||||
|
||||
## Parameters
|
||||
|
||||
* a (`integer`, `float`, `double`, `instruction`) - The first number.
|
||||
* b (`integer`, `float`, `double`, `instruction`) - The second number.
|
||||
|
||||
## Return
|
||||
|
||||
(`boolean`) - True if the first argument is greater than or equal to the second argument.
|
||||
|
||||
## Exceptions
|
||||
|
||||
* `EvaluationException` - If there was an error while evaluating one or more parameters.
|
||||
* `TypeException` - If one or more parameters are not of the expected type.
|
||||
|
||||
## Instruction Example
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "greater_than_or_equals",
|
||||
"_": {
|
||||
"a": 10,
|
||||
"b": 2
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Last Updated
|
||||
|
||||
Monday, December 29th, 2022.
|
||||
Written by [Netkas](https://git.n64.cc/netkas)
|
Loading…
Add table
Add a link
Reference in a new issue