From 4b5dfcc733cf5c56095313fcb16e155886ac9b4d Mon Sep 17 00:00:00 2001 From: nfagerlund Date: Wed, 17 Aug 2011 15:53:27 -0700 Subject: Docs: Copyedit function doc strings This commit makes several minor consistency and wording edits to the doc strings of the stdlib functions. --- lib/puppet/parser/functions/validate_array.rb | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) (limited to 'lib/puppet/parser/functions/validate_array.rb') diff --git a/lib/puppet/parser/functions/validate_array.rb b/lib/puppet/parser/functions/validate_array.rb index a7a7165..34b5118 100644 --- a/lib/puppet/parser/functions/validate_array.rb +++ b/lib/puppet/parser/functions/validate_array.rb @@ -1,17 +1,15 @@ module Puppet::Parser::Functions newfunction(:validate_array, :doc => <<-'ENDHEREDOC') do |args| - Validate all passed values are a Array data structure - value does not pass the check. + Validate that all passed values are array data structures. Abort catalog + compilation if any value fails this check. - Example: - - These values validate + The following values will pass: $my_array = [ 'one', 'two' ] validate_array($my_array) - These values do NOT validate + The following values will fail, causing compilation to abort: validate_array(true) validate_array('some_string') -- cgit v1.2.3