Merge branch 'v2.x'

* v2.x:
  Docs: Clarify the use case for the anchor type
  Docs: Remove author emails from stdlib functions
  Docs: Copyedit function doc strings
  Docs: Correct indentation of markdown code examples
  Docs: Update documentation of stdlib classes
  Docs: Update file_line documentation
  Docs: Improve example in merge function

1 files changed, 4 insertions, 8 deletions

diff --git a/lib/puppet/parser/functions/validate_hash.rb b/lib/puppet/parser/functions/validate_hash.rb
index 1443318..9bdd543 100644
--- a/lib/puppet/parser/functions/validate_hash.rb
+++ b/lib/puppet/parser/functions/validate_hash.rb
@@ -1,25 +1,21 @@
 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')
         $undefined = undef
         validate_hash($undefined)
 
-    * Jeff McCune <jeff@puppetlabs.com>
-
     ENDHEREDOC
 
     unless args.length > 0 then