Update stdlib and concat to 6.1.0 both
[mirror/dsa-puppet.git] / 3rdparty / modules / stdlib / lib / puppet / parser / functions / chomp.rb
index b7b309c..c917d58 100644 (file)
@@ -3,12 +3,18 @@
 #
 module Puppet::Parser::Functions
   newfunction(:chomp, :type => :rvalue, :doc => <<-DOC
-    Removes the record separator from the end of a string or an array of
-    strings, for example `hello\n` becomes `hello`.
+    @summary
+      **Deprecated** Removes the record separator from the end of a string or an array of strings.
+
+    For example `hello\n` becomes `hello`.
     Requires a single string or array as an input.
 
-    Note: from Puppet 6.0.0, the compatible function with the same name in Puppet core
-    will be used instead of this function.
+    > *Note:*
+      **Deprecated** from Puppet 6.0.0, this function has been replaced with a
+    built-in [`chomp`](https://puppet.com/docs/puppet/latest/function.html#chomp) function.
+
+    @return [String] The converted String, if it was a String that was given
+    @return [Array[String]] The converted Array, if it was a Array that was given
     DOC
              ) do |arguments|