diff options
author | Jason Barnett <jason.w.barnett@gmail.com> | 2022-07-19 16:12:49 -0600 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-07-19 15:12:49 -0700 |
commit | de4b2c05256f6d618640f11a5c20e4e1593bbbfc (patch) | |
tree | ff279c5ac7b1c7ded44dd7f1ad9ed246a2f01df7 | |
parent | c09121ae39121d946684bfe6681686693243aec8 (diff) | |
download | chef-de4b2c05256f6d618640f11a5c20e4e1593bbbfc.tar.gz |
update property docs (#13093)
Signed-off-by: Jason Barnett <jason.w.barnett@gmail.com>
-rw-r--r-- | lib/chef/property.rb | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/lib/chef/property.rb b/lib/chef/property.rb index 0813005845..1d91495397 100644 --- a/lib/chef/property.rb +++ b/lib/chef/property.rb @@ -113,9 +113,11 @@ class Chef # and the transformed value returned as output. Lazy values will *not* # be passed to this method until after they are evaluated. Called in the # context of the resource (meaning you can access other properties). - # @option options [Boolean] :required `true` if this property - # must be present; `false` otherwise. This is checked after the resource - # is fully initialized. + # @option options [Boolean, Array<Symbol>] :required `true` if this property + # must be present for *all* actions; `false` otherwise. Alternatively + # you may specify a list of actions the property is required for, when + # the property is only required for a subset of actions. This is checked + # after the resource is fully initialized. # @option options [String] :deprecated If set, this property is deprecated and # will create a deprecation warning. # |