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%2Fchomp.rb;h=c917d580a6ac6bd8855a93dc57f36ea859eea5b0;hp=b7b309c07db542b2afd9032c181a6d8f5d4f4d8a;hb=30caaa85aed7015ca0d77216bff175eebd917eb7;hpb=6f656bd4265e3dab13b9af2bf96e9044322e9d8f

diff --git a/3rdparty/modules/stdlib/lib/puppet/parser/functions/chomp.rb b/3rdparty/modules/stdlib/lib/puppet/parser/functions/chomp.rb
index b7b309c07..c917d580a 100644
--- a/3rdparty/modules/stdlib/lib/puppet/parser/functions/chomp.rb
+++ b/3rdparty/modules/stdlib/lib/puppet/parser/functions/chomp.rb
@@ -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|