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