Update stdlib and concat to 6.1.0 both
[mirror/dsa-puppet.git] / 3rdparty / modules / stdlib / lib / puppet / parser / functions / lstrip.rb
index 99874e4..2fd31a2 100644 (file)
@@ -3,10 +3,14 @@
 #
 module Puppet::Parser::Functions
   newfunction(:lstrip, :type => :rvalue, :doc => <<-DOC
-    Strips leading spaces to the left of a string.
+    @summary
+      **Deprecated:** Strips leading spaces to the left of a string.
 
-    Note: from Puppet 6.0.0, the compatible function with the same name in Puppet core
-    will be used instead of this function.
+    @return [String]
+      The stripped string
+
+    > **Note:** **Deprecated** from Puppet 6.0.0, this function has been replaced with a
+    built-in [`max`](https://puppet.com/docs/puppet/latest/function.html#max) function.
     DOC
              ) do |arguments|