diff options
| author | Helen Campbell <helen@puppetlabs.com> | 2016-09-06 12:30:46 +0100 |
|---|---|---|
| committer | Helen Campbell <helen@puppetlabs.com> | 2016-09-06 12:30:46 +0100 |
| commit | b2d05e9b3f5da65ad3dc39b95b342e9085e52346 (patch) | |
| tree | 00fdf5e7a3c93046c586de91aea7b88fe806a8d1 /README.markdown | |
| parent | 6c6c6d8e3448e3072d590a0782237486e46bc88d (diff) | |
Deprecation README update
Diffstat (limited to 'README.markdown')
| -rw-r--r-- | README.markdown | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/README.markdown b/README.markdown index 26fe55f..aee4e90 100644 --- a/README.markdown +++ b/README.markdown @@ -304,7 +304,7 @@ Deletes all instances of the undef value from an array or hash. For example, `$h #### `deprecation` -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. +A 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). In Puppet version less than 4.0 an environment variable can be set to decide whether or not to log deprecation warnings (ENV[STDLIB_LOG_DEPRECATION]). If this environment variable is set to true, the functions will log a warning. *Type*: String, String. #### `difference` |