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_numeric.rb;h=8b42119ae5a88f02f1008e02851d21f3dc2aa7c4;hp=e127705df82ce75b4cf7a5a8098ca3dc9e7dc36d;hb=30caaa85aed7015ca0d77216bff175eebd917eb7;hpb=6f656bd4265e3dab13b9af2bf96e9044322e9d8f

diff --git a/3rdparty/modules/stdlib/lib/puppet/parser/functions/is_numeric.rb b/3rdparty/modules/stdlib/lib/puppet/parser/functions/is_numeric.rb
index e127705df..8b42119ae 100644
--- a/3rdparty/modules/stdlib/lib/puppet/parser/functions/is_numeric.rb
+++ b/3rdparty/modules/stdlib/lib/puppet/parser/functions/is_numeric.rb
@@ -3,6 +3,9 @@
 #
 module Puppet::Parser::Functions
   newfunction(:is_numeric, :type => :rvalue, :doc => <<-DOC
+    @summary
+      **Deprecated:** Returns true if the given value is numeric.
+
     Returns true if the given argument is a Numeric (Integer or Float),
     or a String containing either a valid integer in decimal base 10 form, or
     a valid floating point string representation.
@@ -13,13 +16,11 @@ module Puppet::Parser::Functions
     The string representation may start with a '-' (minus). If a decimal '.' is used,
     it must be followed by at least one digit.
 
-    Valid examples:
+    @return [Boolean]
+      Returns `true` or `false`
 
-      77435
-      10e-12
-      -8475
-      0.2343
-      -23.561e3
+    > **Note:* **Deprecated** Will be removed in a future version of stdlib. See
+    [`validate_legacy`](#validate_legacy).
     DOC
              ) do |arguments|