diff options
| author |  Mark Griffiths <mark@thebespokepixel.com> | 2014-08-01 03:37:32 +0100 |
|---|---|---|
| committer | Mark Griffiths <mark@thebespokepixel.com> | 2014-09-03 14:43:24 +0100 |
| commit | d282bc462578a6e47747c78d2d42883530f0d11e (patch) | |
| tree | a6515e908d4fc1c400cb6cebaf79b1590b005804 /doc_src/random.txt | |
| parent | 1c4223889bd729ee83aa21a3450dc28f92ade641 (diff) | |
Documentation update
Rework for Doxygen >1.8. Moved large parts of the documentation to a
simplified format, making use of Markdown enhancements and fixing bad
long options.
Diffstat (limited to 'doc_src/random.txt')
| -rw-r--r-- | doc_src/random.txt | 16 |
1 files changed, 9 insertions, 7 deletions
diff --git a/doc_src/random.txt b/doc_src/random.txt index b6bb9df0..abc444a8 100644 --- a/doc_src/random.txt +++ b/doc_src/random.txt @@ -1,13 +1,15 @@ \section random random - generate random number \subsection random-synopsis Synopsis - <tt>random [SEED]</tt> +\fish{syn} +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 \c SEED value is provided, it is used to seed the random number +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 @@ -17,9 +19,9 @@ seeding it, the current time will be used as the seed. 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 |