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_email_address.rb;h=1c41b86bec68395d641b95e64ed0c9609c19eb70;hp=f656468ebc1b9ad4d472e9bc8a488ba4ebff3b71;hb=30caaa85aed7015ca0d77216bff175eebd917eb7;hpb=6f656bd4265e3dab13b9af2bf96e9044322e9d8f

diff --git a/3rdparty/modules/stdlib/lib/puppet/parser/functions/is_email_address.rb b/3rdparty/modules/stdlib/lib/puppet/parser/functions/is_email_address.rb
index f656468eb..1c41b86be 100644
--- a/3rdparty/modules/stdlib/lib/puppet/parser/functions/is_email_address.rb
+++ b/3rdparty/modules/stdlib/lib/puppet/parser/functions/is_email_address.rb
@@ -3,7 +3,14 @@
 #
 module Puppet::Parser::Functions
   newfunction(:is_email_address, :type => :rvalue, :doc => <<-DOC
-    Returns true if the string passed to this function is a valid email address.
+    @summary
+      **Deprecated:** Returns true if the string passed to this function is a valid email 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|
     if arguments.size != 1