diff options
| author | Tim Smith <tsmith@chef.io> | 2018-10-28 21:36:28 -0700 |
|---|---|---|
| committer | Tim Smith <tsmith@chef.io> | 2018-10-30 16:18:46 -0700 |
| commit | bcbb7e14a31769630552e3979dad7d5941d2277c (patch) | |
| tree | e367fa6892ec84492d7b07ebee2f3c1ad42bf3df /lib/chef/resource/macos_userdefaults.rb | |
| parent | f67d152a8bd569d2aac5b034962a7982d2ba5b26 (diff) | |
| download | chef-docs_improvements.tar.gz | |
Add skip_docs and default_description to resource propertiesdocs_improvements
skip_docs is used to specify a property that we don't want to include in the documentation. We have several of these.
default_description is used to describe the default in a way we'd want to put on the docs site. This is particularly useful for describing all our lazy / computed values.
I've used both of these in resources to show how I think we'll use them.
Signed-off-by: Tim Smith <tsmith@chef.io>
Diffstat (limited to 'lib/chef/resource/macos_userdefaults.rb')
| -rw-r--r-- | lib/chef/resource/macos_userdefaults.rb | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/lib/chef/resource/macos_userdefaults.rb b/lib/chef/resource/macos_userdefaults.rb index 9c1acc3334..5eed3f8648 100644 --- a/lib/chef/resource/macos_userdefaults.rb +++ b/lib/chef/resource/macos_userdefaults.rb @@ -58,7 +58,8 @@ class Chef # @todo this should get refactored away: https://github.com/chef/chef/issues/7622 property :is_set, [TrueClass, FalseClass], default: false, - desired_state: false + desired_state: false, + skip_docs: true # coerce various ways of representing a boolean into either 0 (false) or 1 (true) # which is what the defaults CLI expects. Why? Well defaults itself accepts a few |