diff options
| author | Tim Smith <tsmith@chef.io> | 2018-03-04 16:18:52 -0800 |
|---|---|---|
| committer | Tim Smith <tsmith@chef.io> | 2018-03-04 16:39:15 -0800 |
| commit | e0a14935df0c0dd34fdaa8d3228d5d83e4a7cfbd (patch) | |
| tree | 95dd4d1b0e3e1aecdf44e9dee45e885296fd4a10 /lib/chef/resource/ohai_hint.rb | |
| parent | 599f0dfec0c8c2b0d6d6eaf2a594abeebf40ff66 (diff) | |
| download | chef-e0a14935df0c0dd34fdaa8d3228d5d83e4a7cfbd.tar.gz | |
Add more description fields, style fixes, add missing requires
Make sure to require chef/resource everywhere. It would work without it but only because some other resource had already required it.
Put the type on the same line as the property, which we discussed in slack
Put introduced after description which makes differing simpler
Convert some yard into description fields
Signed-off-by: Tim Smith <tsmith@chef.io>
Diffstat (limited to 'lib/chef/resource/ohai_hint.rb')
| -rw-r--r-- | lib/chef/resource/ohai_hint.rb | 12 |
1 files changed, 5 insertions, 7 deletions
diff --git a/lib/chef/resource/ohai_hint.rb b/lib/chef/resource/ohai_hint.rb index 26b76806d7..90755300ca 100644 --- a/lib/chef/resource/ohai_hint.rb +++ b/lib/chef/resource/ohai_hint.rb @@ -21,17 +21,15 @@ class Chef resource_name :ohai_hint provides :ohai_hint - description "A resource to pass hint data to Ohai to aid in configuration detection." + description "Use the ohai_hint resource to pass hint data to Ohai to aid in configuration detection." introduced "14.0" - property :hint_name, - String, - description: "The name of hints file if different from the resource name", + property :hint_name, String, + description: "The name of hints file if different from the resource name.", name_property: true - property :content, - Hash, - description: "Values to include in the hint file" + property :content, Hash, + description: "Values to include in the hint file." property :compile_time, [TrueClass, FalseClass], |