diff options
| author | Eli Young <elyscape@gmail.com> | 2015-06-01 16:09:47 -0700 |
|---|---|---|
| committer | Eli Young <elyscape@gmail.com> | 2015-06-01 16:19:07 -0700 |
| commit | d7c846035321774e824e3424f59cb24703fcfb2a (patch) | |
| tree | daee354e8ff91d86eef6581e05c7c07ee7443223 /README.markdown | |
| parent | 601f681787c8d6c02bb3566b8cefde289377be0e (diff) | |
fqdn_rotate: Improve documentation
Diffstat (limited to 'README.markdown')
| -rw-r--r-- | README.markdown | 15 |
1 files changed, 14 insertions, 1 deletions
diff --git a/README.markdown b/README.markdown index c140af4..8ed3d9b 100644 --- a/README.markdown +++ b/README.markdown @@ -259,7 +259,20 @@ fqdn_rand_string(10, '', 'custom seed') #### `fqdn_rotate` -Rotates an array a random number of times, based on a node's fqdn. *Type*: rvalue. +Rotates an array or string a random number of times, combining the `$fqdn` fact and an optional seed for repeatable randomness. + +*Usage:* +~~~ +fqdn_rotate(VALUE, [SEED]) +~~~ +*Examples:* +~~~ +fqdn_rotate(['a', 'b', 'c', 'd']) +fqdn_rotate('abcd') +fqdn_rotate([1, 2, 3], 'custom seed') +~~~ + +*Type*: rvalue. #### `get_module_path` |