diff options
| author | David Schmitt <david.schmitt@puppet.com> | 2016-07-18 13:27:49 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2016-07-18 13:27:49 +0100 |
| commit | 01bc41e73621fa07d0b14b3b3fa8a75e666a7df5 (patch) | |
| tree | 82a2087cd945247dfadee41dcd8f8cd5bec84ab6 /README.markdown | |
| parent | 9224143da2195c57ce814e837f722348c2038ecb (diff) | |
| parent | 72d23659513517389880ba13663a1d6380d538ca (diff) | |
Merge pull request #617 from tphoney/add_deprecate_function
(MODULES-3529) add deprecation function
Diffstat (limited to 'README.markdown')
| -rw-r--r-- | README.markdown | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/README.markdown b/README.markdown index 1368b2f..f176d98 100644 --- a/README.markdown +++ b/README.markdown @@ -289,6 +289,10 @@ Deletes all instances of a given value from a hash. For example, `delete_values( Deletes all instances of the undef value from an array or hash. For example, `$hash = delete_undef_values({a=>'A', b=>'', c=>undef, d => false})` returns {a => 'A', b => '', d => false}. *Type*: rvalue. +#### `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. + #### `difference` Returns the difference between two arrays. The returned array is a copy of the original array, removing any items that also appear in the second array. For example, `difference(["a","b","c"],["b","c","d"])` returns ["a"]. *Type*: rvalue. |