Mercurial > repos > other > Puppet

diff modules/stdlib/lib/puppet/parser/functions/is_ip_address.rb @ 275:d9352a684e62

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Mass update of modules to remove deprecation warnings
author IBBoard <dev@ibboard.co.uk>
date Sun, 26 Jan 2020 11:36:07 +0000
parents c42fb28cff86
children
line wrap: on
line diff
--- a/modules/stdlib/lib/puppet/parser/functions/is_ip_address.rb	Sat Jan 04 11:42:45 2020 +0000
+++ b/modules/stdlib/lib/puppet/parser/functions/is_ip_address.rb	Sun Jan 26 11:36:07 2020 +0000
@@ -3,7 +3,14 @@
 #
 module Puppet::Parser::Functions
   newfunction(:is_ip_address, :type => :rvalue, :doc => <<-DOC
-    Returns true if the string passed to this function is a valid IP address.
+    @summary
+      **Deprecated:** Returns true if the string passed to this function is a valid IP address.
+
+    @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|