Update stdlib and concat to 6.1.0 both
[mirror/dsa-puppet.git] / 3rdparty / modules / stdlib / lib / puppet / parser / functions / get_module_path.rb
index 3ec6ccd..ac787c6 100644 (file)
@@ -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