Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
WhosyVox authored Apr 23, 2024
1 parent ad5e5da commit 2d373c0
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,10 @@ Random.asShuffled( array ) | returns a copy of the the provided array with the


### Behaviour
Function that take both an upper and lower bound (such as numberBetween) should require both arguments be passed in. This is to ensure that the intent of the code is clear from a glance. Other languages are inconsistent and infer a single parameter to be a range of either \[0,x), \[1,x).
Function that take both an upper and lower bound (such as `numberBetween`) should require both arguments be passed in. This is to ensure that the intent of the code is clear from a glance. Other languages are inconsistent and infer a single parameter to be a range of either \[0,x), \[1,x).

The second parameter does not necessarily need to be the largest. In f(x,y) for y>x the expected range is \[x,y), but for y<x you may get an output (x,y\]. And in the case of x=y, the value will be exactly x.

When either argument is NaN, the expected output is also NaN.

It is still an open question of how and when to clamp values of ±Infinity.
Expand Down

0 comments on commit 2d373c0

Please sign in to comment.