X-Git-Url: https://git.adam-barratt.org.uk/?p=mirror%2Fdsa-puppet.git;a=blobdiff_plain;f=3rdparty%2Fmodules%2Fstdlib%2Flib%2Fpuppet%2Fparser%2Ffunctions%2Fload_module_metadata.rb;h=79d98cdd86c7db4e5ccc86db3bfe386659ae4022;hp=f9a39de95aa686b9c6726a32b7661e33c942d687;hb=30caaa85aed7015ca0d77216bff175eebd917eb7;hpb=6f656bd4265e3dab13b9af2bf96e9044322e9d8f

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 f9a39de95..79d98cdd8 100644
--- 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)