Update stdlib and concat to 6.1.0 both

[mirror/dsa-puppet.git] / 3rdparty / modules / stdlib / lib / puppet / parser / functions / is_ipv4_address.rb

diff --git a/3rdparty/modules/stdlib/lib/puppet/parser/functions/is_ipv4_address.rb b/3rdparty/modules/stdlib/lib/puppet/parser/functions/is_ipv4_address.rb
index 91869b6..5064f48 100644 (file)
--- a/3rdparty/modules/stdlib/lib/puppet/parser/functions/is_ipv4_address.rb
+++ b/3rdparty/modules/stdlib/lib/puppet/parser/functions/is_ipv4_address.rb
@@ -1,18 +1,25 @@
 #
 # is_ipv4_address.rb
 #
-
 module Puppet::Parser::Functions
-  newfunction(:is_ipv4_address, :type => :rvalue, :doc => <<-EOS
-Returns true if the string passed to this function is a valid IPv4 address.
-    EOS
-  ) do |arguments|
+  newfunction(:is_ipv4_address, :type => :rvalue, :doc => <<-DOC
+    @summary
+      **Deprecated:** Returns true if the string passed to this function is a valid IPv4 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|
 
     require 'ipaddr'
 
-    function_deprecation([:is_ipv4_address, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Ipv4. There is further documentation for validate_legacy function in the README.'])
+    function_deprecation([:is_ipv4_address, 'This method is deprecated, please use the stdlib validate_legacy function,
+                            with Stdlib::Compat::Ipv4. There is further documentation for validate_legacy function in the README.'])
 
-    if (arguments.size != 1) then
+    if arguments.size != 1
       raise(Puppet::ParseError, "is_ipv4_address(): Wrong number of arguments given #{arguments.size} for 1")
     end