diff options
author | Tim Smith <tsmith84@gmail.com> | 2020-06-16 08:59:54 -0700 |
---|---|---|
committer | Tim Smith <tsmith84@gmail.com> | 2020-06-16 08:59:54 -0700 |
commit | ff41b02cac4113437d06b3c7e69de9d48e0062a7 (patch) | |
tree | 5212bb5ff521b47776a4c33b188778993a28d178 /lib/chef/resource/cron | |
parent | 5314111f2ee818f905725d85b1b350d6d59eede4 (diff) | |
download | chef-ff41b02cac4113437d06b3c7e69de9d48e0062a7.tar.gz |
Cleanup more resource examplesdocumentation
In execute remove some complex examples that weren't adding much. Also cleanup some of the ruby code so that it would pass cookstyle. Also improve the dist values we use, random formatting, and how we specify notes so they get parsed out correctly.
Signed-off-by: Tim Smith <tsmith@chef.io>
Diffstat (limited to 'lib/chef/resource/cron')
-rw-r--r-- | lib/chef/resource/cron/_cron_shared.rb | 13 |
1 files changed, 6 insertions, 7 deletions
diff --git a/lib/chef/resource/cron/_cron_shared.rb b/lib/chef/resource/cron/_cron_shared.rb index b2e200d27a..13df4b83f3 100644 --- a/lib/chef/resource/cron/_cron_shared.rb +++ b/lib/chef/resource/cron/_cron_shared.rb @@ -60,16 +60,15 @@ property :user, String, default: "root" property :environment, Hash, - description: "A Hash containing additional arbitrary environment variables under which the cron job will be run in the form of `({'ENV_VARIABLE' => 'VALUE'})`.", + description: "A Hash containing additional arbitrary environment variables under which the cron job will be run in the form of `({'ENV_VARIABLE' => 'VALUE'})`. **Note**: These variables must exist for a command to be run successfully.", default: lazy { {} } property :time_out, Hash, - description: "A Hash of timeouts in the form of `({'OPTION' => 'VALUE'})`. - Accepted valid options are: - `preserve-status` (BOOL, default: 'false'), - `foreground` (BOOL, default: 'false'), - `kill-after` (in seconds), - `signal` (a name like 'HUP' or a number)", + description: "A Hash of timeouts in the form of `({'OPTION' => 'VALUE'})`. Accepted valid options are: + - `preserve-status` (BOOL, default: 'false'), + - `foreground` (BOOL, default: 'false'), + - `kill-after` (in seconds), + - `signal` (a name like 'HUP' or a number)", default: lazy { {} }, introduced: "15.7", coerce: proc { |h| |