diff options
Diffstat (limited to 'doc_src/random.txt')
| -rw-r--r-- | doc_src/random.txt | 21 |
1 files changed, 10 insertions, 11 deletions
diff --git a/doc_src/random.txt b/doc_src/random.txt index b6bb9df0..5e50232a 100644 --- a/doc_src/random.txt +++ b/doc_src/random.txt @@ -1,25 +1,24 @@ \section random random - generate random number \subsection random-synopsis Synopsis - <tt>random [SEED]</tt> +\fish{synopsis} +random [SEED] +\endfish \subsection random-description Description -\c random outputs a random number from 0 to 32766, inclusive. +`random` outputs a random number from 0 to 32766, inclusive. + +If a `SEED` value is provided, it is used to seed the random number generator, and no output will be produced. This can be useful for debugging purposes, where it can be desirable to get the same random number sequence multiple times. If the random number generator is called without first seeding it, the current time will be used as the seed. -If a \c SEED value is provided, it is used to seed the random number -generator, and no output will be produced. This can be useful for debugging -purposes, where it can be desirable to get the same random number sequence -multiple times. If the random number generator is called without first -seeding it, the current time will be used as the seed. \subsection random-example Example The following code will count down from a random number to 1: -<pre> +\fish for i in (seq (random) -1 1) - echo $i - sleep + echo $i + sleep end -</pre> +\endfish |