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%2Fget_module_path.rb;h=ac787c65267b5f98ff7dd52c21348f8635228c04;hp=3ec6ccd3c606f24ee8b4a51623e9fb4917d2e731;hb=30caaa85aed7015ca0d77216bff175eebd917eb7;hpb=6f656bd4265e3dab13b9af2bf96e9044322e9d8f diff --git a/3rdparty/modules/stdlib/lib/puppet/parser/functions/get_module_path.rb b/3rdparty/modules/stdlib/lib/puppet/parser/functions/get_module_path.rb index 3ec6ccd3c..ac787c652 100644 --- a/3rdparty/modules/stdlib/lib/puppet/parser/functions/get_module_path.rb +++ b/3rdparty/modules/stdlib/lib/puppet/parser/functions/get_module_path.rb @@ -3,14 +3,22 @@ # module Puppet::Parser::Functions newfunction(:get_module_path, :type => :rvalue, :doc => <<-DOC - Returns the absolute path of the specified module for the current - environment. + @summary + Returns the absolute path of the specified module for the current + environment. - Example: + @return + Returns the absolute path of the specified module for the current + environment. + + @example Example Usage: $module_path = get_module_path('stdlib') - Note that since Puppet 5.4.0 the function `module_directory()` in Puppet does the same thing and will return - the path to the first found module if given multiple values or an array. + > *Note:* + that since Puppet 5.4.0 the built-in + [`module_directory`](https://puppet.com/docs/puppet/latest/function.html#module_directory) + function in Puppet does the same thing and will return the path to the first found module + if given multiple values or an array. DOC ) do |args| raise(Puppet::ParseError, 'get_module_path(): Wrong number of arguments, expects one') unless args.size == 1