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%2Fchop.rb;h=69b5f3ffc266774aaefdca2a11ecaf7eb824a4a4;hp=39a9ee774bf3fe1721029bea7669ad64113e20e3;hb=30caaa85aed7015ca0d77216bff175eebd917eb7;hpb=6f656bd4265e3dab13b9af2bf96e9044322e9d8f

diff --git a/3rdparty/modules/stdlib/lib/puppet/parser/functions/chop.rb b/3rdparty/modules/stdlib/lib/puppet/parser/functions/chop.rb
index 39a9ee774..69b5f3ffc 100644
--- a/3rdparty/modules/stdlib/lib/puppet/parser/functions/chop.rb
+++ b/3rdparty/modules/stdlib/lib/puppet/parser/functions/chop.rb
@@ -3,14 +3,18 @@
 #
 module Puppet::Parser::Functions
   newfunction(:chop, :type => :rvalue, :doc => <<-DOC
-    Returns a new string with the last character removed. If the string ends
-    with `\r\n`, both characters are removed. Applying chop to an empty
-    string returns an empty string. If you wish to merely remove record
-    separators then you should use the `chomp` function.
+    @summary
+      **Deprecated** Returns a new string with the last character removed.
+
+    If the string ends with `\r\n`, both characters are removed. Applying
+    chop to an empty string returns an empty string. If you wish to merely
+    remove record separators then you should use the `chomp` function.
     Requires a string or array of strings as 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 [`chop`](https://puppet.com/docs/puppet/latest/function.html#chop) function.
+
+    @return [String] The given String, sans the last character.
     DOC
              ) do |arguments|