diff options
| author | Tim Smith <tsmith@chef.io> | 2018-09-14 18:06:28 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-09-14 18:06:28 -0700 |
| commit | ee15fa0b1f123e5d736befdced4de332e33dccb4 (patch) | |
| tree | 32c7a27a1673aa797d15b4dd65f137f5bec75537 | |
| parent | 08fbc0c7274ac98d958f7061f611863b243531dc (diff) | |
| parent | 5334ea0b583755178d82512c88f922cbb0d0588f (diff) | |
| download | chef-ee15fa0b1f123e5d736befdced4de332e33dccb4.tar.gz | |
Merge pull request #7645 from chef/resource_doc_fixes
Fix resource descriptions for ohai_hint and rhsm_errata_level
| -rw-r--r-- | lib/chef/resource/ohai_hint.rb | 6 | ||||
| -rw-r--r-- | lib/chef/resource/rhsm_errata_level.rb | 4 |
2 files changed, 4 insertions, 6 deletions
diff --git a/lib/chef/resource/ohai_hint.rb b/lib/chef/resource/ohai_hint.rb index 66146ff16a..483da05e0c 100644 --- a/lib/chef/resource/ohai_hint.rb +++ b/lib/chef/resource/ohai_hint.rb @@ -23,18 +23,18 @@ class Chef resource_name :ohai_hint provides(:ohai_hint) { true } - description "Use the ohai_hint resource to pass hint data to Ohai to aid in configuration detection." + description "Use the ohai_hint resource to aid in configuration detection by passing hint data to Ohai." introduced "14.0" property :hint_name, String, - description: "The name of hints file if different from the resource name.", + description: "The name of the hints file, if it differs from the resource name.", name_property: true property :content, Hash, description: "Values to include in the hint file." property :compile_time, [TrueClass, FalseClass], - description: "Whether the resource will execute during the compile time phase or not.", + description: "Determines whether or not the resource is executed during the compile time phase.", default: true, desired_state: false action :create do diff --git a/lib/chef/resource/rhsm_errata_level.rb b/lib/chef/resource/rhsm_errata_level.rb index baf1abfc9c..12193c6942 100644 --- a/lib/chef/resource/rhsm_errata_level.rb +++ b/lib/chef/resource/rhsm_errata_level.rb @@ -23,9 +23,7 @@ class Chef resource_name :rhsm_errata_level provides(:rhsm_errata_level) { true } - description " Use the rhsm_errata_level resource to install all packages of a specified errata level"\ - " from the Red Hat Subscript Manager. For example, you can ensure that all packages associated"\ - " with errata marked at a 'Critical' security level are installed." + description "Use the rhsm_errata_level resource to install all packages of a specified errata level from the Red Hat Subscription Manager. For example, you can ensure that all packages associated with errata marked at a 'Critical' security level are installed." introduced "14.0" property :errata_level, String, |