Puppet Function: deprecation

Defined in:
vendor_modules/stdlib/lib/puppet/parser/functions/deprecation.rb
Function type:
Ruby 3.x API

Summary

Function to print deprecation warnings (this is the 3.X version of it).

Overview

deprecation() ⇒ String

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.).

Returns:

  • (String) —

    return deprecation warnings



7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
 
# File 'vendor_modules/stdlib/lib/puppet/parser/functions/deprecation.rb', line 7

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'
    warning("deprecation. #{key}. #{message}")
  end
end