Update stdlib and concat to 6.1.0 both

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

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 1421b91..ac787c6 100644 (file)
--- a/3rdparty/modules/stdlib/lib/puppet/parser/functions/get_module_path.rb
+++ b/3rdparty/modules/stdlib/lib/puppet/parser/functions/get_module_path.rb
@@ -1,17 +1,29 @@
+#
+# get_module_path.rb
+#
 module Puppet::Parser::Functions
-  newfunction(:get_module_path, :type =>:rvalue, :doc => <<-EOT
-    Returns the absolute path of the specified module for the current
-    environment.
+  newfunction(:get_module_path, :type => :rvalue, :doc => <<-DOC
+    @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')
-  EOT
-  ) do |args|
-    raise(Puppet::ParseError, "get_module_path(): Wrong number of arguments, expects one") unless args.size == 1
-    if module_path = Puppet::Module.find(args[0], compiler.environment.to_s)
-      module_path.path
-    else
-      raise(Puppet::ParseError, "Could not find module #{args[0]} in environment #{compiler.environment}")
-    end
+
+    > *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
+    module_path = Puppet::Module.find(args[0], compiler.environment.to_s)
+    raise(Puppet::ParseError, "Could not find module #{args[0]} in environment #{compiler.environment}") unless module_path
+    module_path.path
   end
 end