Update stdlib and concat to 6.1.0 both

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

diff --git a/3rdparty/modules/stdlib/lib/puppet/parser/functions/deprecation.rb b/3rdparty/modules/stdlib/lib/puppet/parser/functions/deprecation.rb
index 39d306a..2a39cc3 100644 (file)
--- a/3rdparty/modules/stdlib/lib/puppet/parser/functions/deprecation.rb
+++ b/3rdparty/modules/stdlib/lib/puppet/parser/functions/deprecation.rb
@@ -1,15 +1,25 @@
+#
+# deprecation.rb
+#
 module Puppet::Parser::Functions
-  newfunction(:deprecation, :doc => <<-EOS
-  Function to print deprecation warnings (this is the 3.X version of it), The uniqueness key - can appear once. The msg is the message text including any positional information that is formatted by the user/caller of the method.).
-EOS
-  ) do |arguments|
+  newfunction(:deprecation, :doc => <<-DOC
+  @summary
+    Function to print deprecation warnings (this is the 3.X version of it).
+
+  The uniqueness key - can appear once. The msg is the message text including any positional
+  information that is formatted by the user/caller of the method.).
+
+  @return [String]
+    return deprecation warnings
+DOC
+             ) do |arguments|
 
     raise(Puppet::ParseError, "deprecation: Wrong number of arguments given (#{arguments.size} for 2)") unless arguments.size == 2
 
     key = arguments[0]
     message = arguments[1]
 
-    if ENV['STDLIB_LOG_DEPRECATIONS'] == "true"
+    if ENV['STDLIB_LOG_DEPRECATIONS'] == 'true'
       warning("deprecation. #{key}. #{message}")
     end
   end