Update stdlib and concat to 6.1.0 both

[mirror/dsa-puppet.git] / 3rdparty / modules / stdlib / lib / puppet / parser / functions / load_module_metadata.rb

diff --git a/3rdparty/modules/stdlib/lib/puppet/parser/functions/load_module_metadata.rb b/3rdparty/modules/stdlib/lib/puppet/parser/functions/load_module_metadata.rb
index f9a39de..79d98cd 100644 (file)
--- a/3rdparty/modules/stdlib/lib/puppet/parser/functions/load_module_metadata.rb
+++ b/3rdparty/modules/stdlib/lib/puppet/parser/functions/load_module_metadata.rb
@@ -3,7 +3,15 @@
 #
 module Puppet::Parser::Functions
   newfunction(:load_module_metadata, :type => :rvalue, :doc => <<-DOC
-    This function loads the metadata of a given module.
+    @summary
+      This function loads the metadata of a given module.
+
+    @example Example USage:
+      $metadata = load_module_metadata('archive')
+      notify { $metadata['author']: }
+
+    @return
+      The modules metadata
   DOC
              ) do |args|
     raise(Puppet::ParseError, 'load_module_metadata(): Wrong number of arguments, expects one or two') unless [1, 2].include?(args.size)