Mirrors/fish-shell
2
0
Fork 0
mirror of https://github.com/fish-shell/fish-shell synced 2024-12-30 14:53:11 +00:00
Code Issues Projects Releases Packages Wiki Activity

docs: Reword random

Browse source 
Don't SCREAMCAPS random, the command is `random`.

Also some stuffy verbiage.

[ci skip]
This commit is contained in:
Fabian Homborg 2020-09-10 20:48:13 +02:00
parent 624d0b7e42
commit c6cdc06a5b
1 changed files with 21 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

33
doc_src/cmds/random.rst
View file

@ -17,20 +17,23 @@ Synopsis
Description Description
----------- -----------
``RANDOM`` generates a pseudo-random integer from a uniform distribution. The ``random`` generates a pseudo-random integer from a uniform distribution. The
range (inclusive) is dependent on the arguments passed. range (inclusive) depends on the arguments.
No arguments indicate a range of [0; 32767]. No arguments indicate a range of 0 to 32767 (inclusive).
If one argument is specified, the internal engine will be seeded with the 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. 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 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. 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 Note that seeding the engine will NOT give the same result across different
systems. systems.
You should not consider ``RANDOM`` cryptographically secure, or even You should not consider ``random`` cryptographically secure, or even
statistically accurate. statistically accurate.
Example Example
@ -38,8 +41,6 @@ Example
The following code will count down from a random even number between 10 and 20 to 1: 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) for i in (seq (random 10 2 20) -1 1)
@ -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: 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