Improve resource documentation #10570
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Tim Smith <tsmith@chef.io>
Signed-off-by: Tim Smith <tsmith@chef.io>
phiggins
reviewed
Oct 28, 2020
lib/chef/resource/scm/_scm.rb
Outdated
| @@ -33,7 +33,8 @@ | |||
| default: "HEAD" | |||
|
|
|||
| property :user, [String, Integer], | |||
| description: "The system user that will own the checked-out code." | |||
| description: "The system user that will own the checked-out code.", | |||
| default_description: "`HOME` environment variable of the current user" | |||
There was a problem hiding this comment.
Is this description accurate? If so, I'm not sure I understand it.
There was a problem hiding this comment.
It's ENV['HOME'] of the user running chef-client. I tried to write something brief so it fits in the format of the docs site.
phiggins
reviewed
Oct 28, 2020
phiggins
reviewed
Oct 28, 2020
phiggins
reviewed
Oct 28, 2020
phiggins
approved these changes
Oct 28, 2020
Co-authored-by: pete higgins <pete@peterhiggins.org>
Signed-off-by: Tim Smith <tsmith@chef.io> Co-authored-by: pete higgins <pete@peterhiggins.org>
Signed-off-by: Tim Smith <tsmith@chef.io>
Signed-off-by: Tim Smith <tsmith@chef.io>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Get closer to just being able to auto-generate the world
Signed-off-by: Tim Smith tsmith@chef.io