summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTim Smith <tsmith84@gmail.com>2020-05-01 11:09:27 -0700
committerTim Smith <tsmith84@gmail.com>2020-05-01 11:09:27 -0700
commitba47fec47fc34c718713fbcebea55fd44e4eaba7 (patch)
tree4088a54c525cc7ff451a5ed87a93bfb5124b4a2c
parent8ca564d1f518bb57ceaf0c470c07de15e89fc78b (diff)
downloadchef-ba47fec47fc34c718713fbcebea55fd44e4eaba7.tar.gz
Fix more resource formatting
Signed-off-by: Tim Smith <tsmith@chef.io>
-rw-r--r--lib/chef/resource/cron.rb8
-rw-r--r--lib/chef/resource/cron_d.rb10
-rw-r--r--lib/chef/resource/dpkg_package.rb2
3 files changed, 10 insertions, 10 deletions
diff --git a/lib/chef/resource/cron.rb b/lib/chef/resource/cron.rb
index 6caeaf7d97..baabe4d5d9 100644
--- a/lib/chef/resource/cron.rb
+++ b/lib/chef/resource/cron.rb
@@ -41,25 +41,25 @@ class Chef
end
property :minute, [Integer, String],
- description: "The minute at which the cron entry should run (0 - 59).",
+ description: "The minute at which the cron entry should run (`0 - 59`).",
default: "*", callbacks: {
"should be a valid minute spec" => ->(spec) { Chef::ResourceHelpers::CronValidations.validate_numeric(spec, 0, 59) },
}
property :hour, [Integer, String],
- description: "The hour at which the cron entry is to run (0 - 23).",
+ description: "The hour at which the cron entry is to run (`0 - 23`).",
default: "*", callbacks: {
"should be a valid hour spec" => ->(spec) { Chef::ResourceHelpers::CronValidations.validate_numeric(spec, 0, 23) },
}
property :day, [Integer, String],
- description: "The day of month at which the cron entry should run (1 - 31).",
+ description: "The day of month at which the cron entry should run (`1 - 31`).",
default: "*", callbacks: {
"should be a valid day spec" => ->(spec) { Chef::ResourceHelpers::CronValidations.validate_numeric(spec, 1, 31) },
}
property :month, [Integer, String],
- description: "The month in the year on which a cron entry is to run (1 - 12, jan-dec, or *).",
+ description: "The month in the year on which a cron entry is to run (`1 - 12`, `jan-dec`, or `*`).",
default: "*", callbacks: {
"should be a valid month spec" => ->(spec) { Chef::ResourceHelpers::CronValidations.validate_month(spec) },
}
diff --git a/lib/chef/resource/cron_d.rb b/lib/chef/resource/cron_d.rb
index 2863a88380..91027f0f4c 100644
--- a/lib/chef/resource/cron_d.rb
+++ b/lib/chef/resource/cron_d.rb
@@ -89,31 +89,31 @@ class Chef
equal_to: %w{ @reboot @yearly @annually @monthly @weekly @daily @midnight @hourly }
property :minute, [Integer, String],
- description: "The minute at which the cron entry should run (0 - 59).",
+ description: "The minute at which the cron entry should run (`0 - 59`).",
default: "*", callbacks: {
"should be a valid minute spec" => ->(spec) { Chef::ResourceHelpers::CronValidations.validate_numeric(spec, 0, 59) },
}
property :hour, [Integer, String],
- description: "The hour at which the cron entry is to run (0 - 23).",
+ description: "The hour at which the cron entry is to run (`0 - 23`).",
default: "*", callbacks: {
"should be a valid hour spec" => ->(spec) { Chef::ResourceHelpers::CronValidations.validate_numeric(spec, 0, 23) },
}
property :day, [Integer, String],
- description: "The day of month at which the cron entry should run (1 - 31).",
+ description: "The day of month at which the cron entry should run (`1 - 31`).",
default: "*", callbacks: {
"should be a valid day spec" => ->(spec) { Chef::ResourceHelpers::CronValidations.validate_numeric(spec, 1, 31) },
}
property :month, [Integer, String],
- description: "The month in the year on which a cron entry is to run (1 - 12, jan-dec, or *).",
+ description: "The month in the year on which a cron entry is to run (`1 - 12`, `jan-dec`, or `*`).",
default: "*", callbacks: {
"should be a valid month spec" => ->(spec) { Chef::ResourceHelpers::CronValidations.validate_month(spec) },
}
property :weekday, [Integer, String],
- description: "The day of the week on which this entry is to run (0-7, mon-sun, or *), where Sunday is both 0 and 7.",
+ description: "The day of the week on which this entry is to run (`0-7`, `mon-sun`, or `*`), where Sunday is both `0` and `7`.",
default: "*", callbacks: {
"should be a valid weekday spec" => ->(spec) { Chef::ResourceHelpers::CronValidations.validate_dow(spec) },
}
diff --git a/lib/chef/resource/dpkg_package.rb b/lib/chef/resource/dpkg_package.rb
index ffc15b49c5..466b17d702 100644
--- a/lib/chef/resource/dpkg_package.rb
+++ b/lib/chef/resource/dpkg_package.rb
@@ -25,7 +25,7 @@ class Chef
provides :dpkg_package
- description "Use the **dpkg_package** resource to manage packages for the dpkg platform. When a package is installed from a local file, it must be added to the node using the remote_file or cookbook_file resources."
+ description "Use the **dpkg_package** resource to manage packages for the dpkg platform. When a package is installed from a local file, it must be added to the node using the **remote_file** or **cookbook_file** resources."
property :source, [ String, Array, nil ],
description: "The path to a package in the local file system."