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_hash.rb | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) (limited to 'lib/puppet/parser/functions/validate_hash.rb') diff --git a/lib/puppet/parser/functions/validate_hash.rb b/lib/puppet/parser/functions/validate_hash.rb index 1443318..1b1c854 100644 --- a/lib/puppet/parser/functions/validate_hash.rb +++ b/lib/puppet/parser/functions/validate_hash.rb @@ -1,17 +1,15 @@ module Puppet::Parser::Functions newfunction(:validate_hash, :doc => <<-'ENDHEREDOC') do |args| - Validate all passed values are a Hash data structure - value does not pass the check. + Validate that all passed values are hash data structures. Abort catalog + compilation if any value fails this check. - Example: - - These values validate + The following values will pass: $my_hash = { 'one' => 'two' } validate_hash($my_hash) - These values do NOT validate + The following values will fail, causing compilation to abort: validate_hash(true) validate_hash('some_string') -- cgit v1.2.3 From 9e87fd14571ba3a75789417e7aa4df05d4a7345c Mon Sep 17 00:00:00 2001 From: nfagerlund Date: Wed, 17 Aug 2011 15:55:07 -0700 Subject: Docs: Remove author emails from stdlib functions Author email addresses were included in the doc strings for some (but not all) stdlib functions. This commit removes them in the interest of consistency. --- lib/puppet/parser/functions/validate_hash.rb | 2 -- 1 file changed, 2 deletions(-) (limited to 'lib/puppet/parser/functions/validate_hash.rb') diff --git a/lib/puppet/parser/functions/validate_hash.rb b/lib/puppet/parser/functions/validate_hash.rb index 1b1c854..9bdd543 100644 --- a/lib/puppet/parser/functions/validate_hash.rb +++ b/lib/puppet/parser/functions/validate_hash.rb @@ -16,8 +16,6 @@ module Puppet::Parser::Functions $undefined = undef validate_hash($undefined) - * Jeff McCune - ENDHEREDOC unless args.length > 0 then -- cgit v1.2.3