From f241316e5df156973a794b4f30328a9582c1ee6e Mon Sep 17 00:00:00 2001 From: Tim Smith Date: Thu, 15 Oct 2020 11:23:24 -0700 Subject: Minor updates for documentation generation A few formatting fixes so that things generate properly Signed-off-by: Tim Smith --- lib/chef/resource/route.rb | 2 +- lib/chef/resource/sudo.rb | 2 +- lib/chef/resource/systemd_unit.rb | 2 +- lib/chef/resource/windows_certificate.rb | 2 +- lib/chef/resource/windows_font.rb | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/lib/chef/resource/route.rb b/lib/chef/resource/route.rb index 9df2031dcb..82f961679b 100644 --- a/lib/chef/resource/route.rb +++ b/lib/chef/resource/route.rb @@ -43,7 +43,7 @@ class Chef description: "The route metric value." property :netmask, [String, nil], - description: "The decimal representation of the network mask. For example: 255.255.255.0." + description: "The decimal representation of the network mask. For example: `255.255.255.0`." property :gateway, [String, nil], description: "The gateway for the route." diff --git a/lib/chef/resource/sudo.rb b/lib/chef/resource/sudo.rb index 99bea022ef..d6587bd441 100644 --- a/lib/chef/resource/sudo.rb +++ b/lib/chef/resource/sudo.rb @@ -30,7 +30,7 @@ class Chef description "Use the **sudo** resource to add or remove individual sudo entries using sudoers.d files."\ " Sudo version 1.7.2 or newer is required to use the sudo resource, as it relies on the"\ - " '#includedir' directive introduced in version 1.7.2. This resource does not enforce"\ + " `#includedir` directive introduced in version 1.7.2. This resource does not enforce"\ " installation of the required sudo version. Chef-supported releases of Ubuntu, SuSE, Debian,"\ " and RHEL (6+) all support this feature." introduced "14.0" diff --git a/lib/chef/resource/systemd_unit.rb b/lib/chef/resource/systemd_unit.rb index c220c18450..fc9aa4d40f 100644 --- a/lib/chef/resource/systemd_unit.rb +++ b/lib/chef/resource/systemd_unit.rb @@ -27,7 +27,7 @@ class Chef provides(:systemd_unit) { true } - description "Use the **systemd_unit** resource to create, manage, and run systemd units." + description "Use the **systemd_unit** resource to create, manage, and run [systemd units](https://www.freedesktop.org/software/systemd/man/systemd.html#Concepts)." introduced "12.11" default_action :nothing diff --git a/lib/chef/resource/windows_certificate.rb b/lib/chef/resource/windows_certificate.rb index 62028c0c6e..68874af4d0 100644 --- a/lib/chef/resource/windows_certificate.rb +++ b/lib/chef/resource/windows_certificate.rb @@ -80,7 +80,7 @@ class Chef default: false property :cert_path, String, - description: "" + description: "The path to the certificate." # lazy used to set default value of sensitive to true if password is set property :sensitive, [TrueClass, FalseClass], diff --git a/lib/chef/resource/windows_font.rb b/lib/chef/resource/windows_font.rb index afc8a7a987..c9128aa4b0 100644 --- a/lib/chef/resource/windows_font.rb +++ b/lib/chef/resource/windows_font.rb @@ -32,7 +32,7 @@ class Chef ```ruby windows_font 'Custom.otf' do - source "https://example.com/Custom.otf" + source 'https://example.com/Custom.otf' end ``` DOC -- cgit v1.2.1