Add more description fields, style fixes, add missing requires #6943
Conversation
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>
lib/chef/resource/build_essential.rb
Outdated
| description "Use the build_essential resource to install packages required for compiling C software from source" | ||
| introduced "14.0" | ||
|
|
||
| property :compile_time, [true, false], |
There was a problem hiding this comment.
Shouldn't the type (and default) here be [TrueClass, FalseClass] for consistency?
| description "Use the macos_userdefaults resource to manage the macOS user defaults"\ | ||
| " system. The properties to the resource are passed to the defaults command"\ | ||
| " and the parameters follow convention of the macOS command. See the defaults(1)"\ | ||
| " man page for details on how the tool works." | ||
| introduced "14.0" | ||
|
|
||
| property :domain, | ||
| String, |
There was a problem hiding this comment.
Move the type up to the property line for consistency with other resources?
| 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], |
There was a problem hiding this comment.
Move the type up to the property line for consistency with other resources?
lib/chef/resource/osx_profile.rb
Outdated
|
|
||
| default_action :install | ||
|
|
||
| allowed_actions :install, :remove | ||
|
|
||
| property :profile_name, String, name_property: true |
There was a problem hiding this comment.
Should name_property be on the same line as the property name? Looks inconsistent with other modernized resources.
| description: "The username to use when registering. Not applicable if using an activation key. If specified, password and environment are also required." | ||
|
|
||
| property :password, | ||
| String, | ||
| property :password, String, | ||
| description: "The password to use when registering. Not applicable if using an activation key. If specified, username and environment are also required." | ||
|
|
||
| property :auto_attach, | ||
| [TrueClass, FalseClass], |
There was a problem hiding this comment.
Why not move this one up to the property line?
There was a problem hiding this comment.
I wasn't breaking them up until I added the descriptions. That bloats the lines so much it's easier to read on individual lines.
Signed-off-by: Tim Smith <tsmith@chef.io>
|
This thread has been automatically locked because it has not had recent activity. Please open a new issue for related bugs and link to relevant comments in this thread. |
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