From c6cdc06a5bcbffaf214edf7b09bdac3dcaa245bf Mon Sep 17 00:00:00 2001 From: Fabian Homborg Date: Thu, 10 Sep 2020 20:48:13 +0200 Subject: [PATCH] docs: Reword random Don't SCREAMCAPS random, the command is `random`. Also some stuffy verbiage. [ci skip] --- doc_src/cmds/random.rst | 35 +++++++++++++++++++++-------------- 1 file changed, 21 insertions(+), 14 deletions(-) diff --git a/doc_src/cmds/random.rst b/doc_src/cmds/random.rst index 7b912af83..5455ccc3b 100644 --- a/doc_src/cmds/random.rst +++ b/doc_src/cmds/random.rst @@ -17,20 +17,23 @@ Synopsis Description ----------- -``RANDOM`` generates a pseudo-random integer from a uniform distribution. The -range (inclusive) is dependent on the arguments passed. -No arguments indicate a range of [0; 32767]. +``random`` generates a pseudo-random integer from a uniform distribution. The +range (inclusive) depends on the arguments. +No arguments indicate a range of 0 to 32767 (inclusive). + If one argument is specified, the internal engine will be seeded with the -argument for future invocations of ``RANDOM`` and no output will be produced. -Two arguments indicate a range of [START; END]. -Three arguments indicate a range of [START; END] with a spacing of STEP +argument for future invocations of ``random`` and no output will be produced. + +Two arguments indicate a range from START to END (both START and END included). + +Three arguments indicate a range from START to END with a spacing of STEP between possible outputs. -``RANDOM choice`` will select one random item from the succeeding arguments. +``random choice`` will select one random item from the succeeding arguments. Note that seeding the engine will NOT give the same result across different systems. -You should not consider ``RANDOM`` cryptographically secure, or even +You should not consider ``random`` cryptographically secure, or even statistically accurate. Example @@ -38,10 +41,8 @@ Example The following code will count down from a random even number between 10 and 20 to 1: - - :: - + for i in (seq (random 10 2 20) -1 1) echo $i end @@ -49,9 +50,15 @@ The following code will count down from a random even number between 10 and 20 t And this will open a random picture from any of the subdirectories: - - :: - open (random choice **jpg) + open (random choice **.jpg) + +Or, to only get even numbers from 2 to 20:: + + random 2 2 20 + +Or odd numbers from 1 to 3:: + + random 1 2 3 # or 1 2 4