X-Git-Url: https://git.adam-barratt.org.uk/?a=blobdiff_plain;f=3rdparty%2Fmodules%2Fstdlib%2Flib%2Fpuppet%2Fparser%2Ffunctions%2Fglob.rb;h=5475b74b3d8e15691ffaf8825d265cf01c7fe652;hb=30caaa85aed7015ca0d77216bff175eebd917eb7;hp=54cdda61d0cd78cbd3fc2a6e5edf7742b8fa67ce;hpb=6963202b4b62c2816655ac9532521b018fdf83bd;p=mirror%2Fdsa-puppet.git

diff --git a/3rdparty/modules/stdlib/lib/puppet/parser/functions/glob.rb b/3rdparty/modules/stdlib/lib/puppet/parser/functions/glob.rb
index 54cdda61d..5475b74b3 100644
--- a/3rdparty/modules/stdlib/lib/puppet/parser/functions/glob.rb
+++ b/3rdparty/modules/stdlib/lib/puppet/parser/functions/glob.rb
@@ -1,21 +1,30 @@
 #
 #  glob.rb
 #
-
 module Puppet::Parser::Functions
-  newfunction(:glob, :type => :rvalue, :doc => <<-'EOS'
-    Returns an Array of file entries of a directory or an Array of directories.
-    Uses same patterns as Dir#glob
-    EOS
-  ) do |arguments|
+  newfunction(:glob, :type => :rvalue, :doc => <<-DOC
+    @summary
+      Uses same patterns as Dir#glob.
+
+    @return
+      Returns an Array of file entries of a directory or an Array of directories.
+
+    @example Example Usage:
+      $confs = glob(['/etc/**/*.conf', '/opt/**/*.conf'])
+    DOC
+             ) do |arguments|
 
-    raise(Puppet::ParseError, "glob(): Wrong number of arguments given " +
-      "(#{arguments.size} for 1)") unless arguments.size == 1
+    unless arguments.size == 1
+      raise(Puppet::ParseError, 'glob(): Wrong number of arguments given ' \
+        "(#{arguments.size} for 1)")
+    end
 
     pattern = arguments[0]
 
-    raise(Puppet::ParseError, 'glob(): Requires either array or string ' +
-      'to work') unless pattern.is_a?(String) || pattern.is_a?(Array)
+    unless pattern.is_a?(String) || pattern.is_a?(Array)
+      raise(Puppet::ParseError, 'glob(): Requires either array or string ' \
+        'to work')
+    end
 
     Dir.glob(pattern)
   end