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%2Fis_integer.rb;h=a86b5cddcb35740be7749ac427b182788405a88b;hp=7444cace7fdd52a163b666b11ac1ef7cafd0b27f;hb=30caaa85aed7015ca0d77216bff175eebd917eb7;hpb=6f656bd4265e3dab13b9af2bf96e9044322e9d8f

diff --git a/3rdparty/modules/stdlib/lib/puppet/parser/functions/is_integer.rb b/3rdparty/modules/stdlib/lib/puppet/parser/functions/is_integer.rb
index 7444cace7..a86b5cddc 100644
--- a/3rdparty/modules/stdlib/lib/puppet/parser/functions/is_integer.rb
+++ b/3rdparty/modules/stdlib/lib/puppet/parser/functions/is_integer.rb
@@ -3,12 +3,20 @@
 #
 module Puppet::Parser::Functions
   newfunction(:is_integer, :type => :rvalue, :doc => <<-DOC
-    Returns true if the variable passed to this function is an Integer or
-    a decimal (base 10) integer in String form. The string may
-    start with a '-' (minus). A value of '0' is allowed, but a leading '0' digit may not
-    be followed by other digits as this indicates that the value is octal (base 8).
+    @summary
+      **Deprecated:** Returns true if the variable passed to this function is an Integer or
+      a decimal (base 10) integer in String form.
+
+    The string may start with a '-' (minus). A value of '0' is allowed, but a leading '0'
+    digit may not be followed by other digits as this indicates that the value is octal (base 8).
 
     If given any other argument `false` is returned.
+
+    @return [Boolean]
+      Returns `true` or `false`
+
+    > **Note:* **Deprecated** Will be removed in a future version of stdlib. See
+    [`validate_legacy`](#validate_legacy).
     DOC
              ) do |arguments|