Mercurial > repos > other > Puppet
diff modules/stdlib/lib/puppet/functions/deprecation.rb @ 275:d9352a684e62
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 | adf6fe9bbc17 |
line wrap: on
line diff
--- a/modules/stdlib/lib/puppet/functions/deprecation.rb Sat Jan 04 11:42:45 2020 +0000 +++ b/modules/stdlib/lib/puppet/functions/deprecation.rb Sun Jan 26 11:36:07 2020 +0000 @@ -1,10 +1,16 @@ -# Function to print deprecation warnings, Logs a warning once for a given key. 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. -# It is affected by the puppet setting 'strict', which can be set to :error (outputs as an error message), -# :off (no message / error is displayed) and :warning (default, outputs a warning) *Type*: String, String. +# Function to print deprecation warnings, Logs a warning once for a given key. # - +# 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. +# It is affected by the puppet setting 'strict', which can be set to :error +# (outputs as an error message), :off (no message / error is displayed) and :warning +# (default, outputs a warning) *Type*: String, String. +# Puppet::Functions.create_function(:deprecation) do + # @param key + # @param message + # @return deprecated warnings dispatch :deprecation do param 'String', :key param 'String', :message