Skip to content

Commit 09d8317

Browse files
committed
Fixed some function documentation.
1 parent d7add91 commit 09d8317

2 files changed

Lines changed: 8 additions & 2 deletions

File tree

docs/CHANGELOG.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,12 @@ RookScript (C) Black Rook Software
33
by Matt Tropiano et al. (see AUTHORS.txt)
44

55

6+
Changed in 1.16.2
7+
-----------------
8+
9+
- `Fixed` Some function documentation that was misleading.
10+
11+
612
Changed in 1.16.1
713
-----------------
814

src/main/java/com/blackrook/rookscript/functions/RandomFunctions.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -206,7 +206,7 @@ protected Usage usage()
206206
type(Type.OBJECTREF, "Random", "The random number generator.")
207207
)
208208
.returns(
209-
type(Type.FLOAT, "A random integer from 0.0 to 1.0 (exclusive)."),
209+
type(Type.FLOAT, "A random float from 0.0 to 1.0 (exclusive)."),
210210
type(Type.ERROR, "BadRandom", "If a random number generator was not provided.")
211211
)
212212
;
@@ -250,7 +250,7 @@ protected Usage usage()
250250
type(Type.OBJECTREF, "Random", "The random number generator.")
251251
)
252252
.returns(
253-
type(Type.FLOAT, "A random integer from 0.0 to 1.0."),
253+
type(Type.FLOAT, "A random float, such that the mean is around 0.0, but the range is infinite."),
254254
type(Type.ERROR, "BadRandom", "If a random number generator was not provided.")
255255
)
256256
;

0 commit comments

Comments
 (0)