Mercurial > repos > other > Puppet
diff modules/stdlib/lib/puppet/parser/functions/load_module_metadata.rb @ 275:d9352a684e62
Mass update of modules to remove deprecation warnings
| author | IBBoard <dev@ibboard.co.uk> |
|---|---|
| date | Sun, 26 Jan 2020 11:36:07 +0000 |
| parents | c42fb28cff86 |
| children | adf6fe9bbc17 |
line wrap: on
line diff
--- a/modules/stdlib/lib/puppet/parser/functions/load_module_metadata.rb Sat Jan 04 11:42:45 2020 +0000 +++ b/modules/stdlib/lib/puppet/parser/functions/load_module_metadata.rb Sun Jan 26 11:36:07 2020 +0000 @@ -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)