diff options
| author | nfagerlund <nick.fagerlund@gmail.com> | 2011-08-17 15:53:27 -0700 |
|---|---|---|
| committer | nfagerlund <nick.fagerlund@gmail.com> | 2011-08-18 12:39:04 -0700 |
| commit | 4b5dfcc733cf5c56095313fcb16e155886ac9b4d (patch) | |
| tree | f16152e15b5bcdf8e341f933fadc3ca3581cb969 /lib/puppet/parser/functions/validate_string.rb | |
| parent | 400b91ab02428c6a51886f31cbb12b9d4852b6e9 (diff) | |
| download | puppet-stdlib-4b5dfcc733cf5c56095313fcb16e155886ac9b4d.tar.gz puppet-stdlib-4b5dfcc733cf5c56095313fcb16e155886ac9b4d.tar.bz2 | |
Docs: Copyedit function doc strings
This commit makes several minor consistency and wording edits to the doc
strings of the stdlib functions.
Diffstat (limited to 'lib/puppet/parser/functions/validate_string.rb')
| -rw-r--r-- | lib/puppet/parser/functions/validate_string.rb | 12 |
1 files changed, 5 insertions, 7 deletions
diff --git a/lib/puppet/parser/functions/validate_string.rb b/lib/puppet/parser/functions/validate_string.rb index d0e1376..e667794 100644 --- a/lib/puppet/parser/functions/validate_string.rb +++ b/lib/puppet/parser/functions/validate_string.rb @@ -1,17 +1,15 @@ module Puppet::Parser::Functions newfunction(:validate_string, :doc => <<-'ENDHEREDOC') do |args| - Validate all passed values are a string data structure - value does not pass the check. + Validate that all passed values are string data structures. Abort catalog + compilation if any value fails this check. - Example: - - These values validate + The following values will pass: $my_string = "one two" - validate_string($my_string) + validate_string($my_string, 'three') - These values do NOT validate + The following values will fail, causing compilation to abort: validate_string(true) validate_string([ 'some', 'array' ]) |