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%2Fregexpescape.rb;h=43b729ea89c1ef1994d9bb8efcc4008f105c554b;hp=647d865f967826e9fd49037eb9fb34f7449544ff;hb=30caaa85aed7015ca0d77216bff175eebd917eb7;hpb=6f656bd4265e3dab13b9af2bf96e9044322e9d8f

diff --git a/3rdparty/modules/stdlib/lib/puppet/parser/functions/regexpescape.rb b/3rdparty/modules/stdlib/lib/puppet/parser/functions/regexpescape.rb
index 647d865f9..43b729ea8 100644
--- a/3rdparty/modules/stdlib/lib/puppet/parser/functions/regexpescape.rb
+++ b/3rdparty/modules/stdlib/lib/puppet/parser/functions/regexpescape.rb
@@ -3,8 +3,11 @@
 #
 module Puppet::Parser::Functions
   newfunction(:regexpescape, :type => :rvalue, :doc => <<-DOC
-    Regexp escape a string or array of strings.
-    Requires either a single string or an array as an input.
+    @summary
+      Regexp escape a string or array of strings.
+      Requires either a single string or an array as an input.
+    @return [String]
+      A string of characters with metacharacters converted to their escaped form.
     DOC
   ) do |arguments| # rubocop:disable Layout/ClosingParenthesisIndentation
     raise(Puppet::ParseError, "regexpescape(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty?