Another round of description updates

Signed-off-by: Tim Smith <tsmith@chef.io>

8 files changed, 13 insertions, 12 deletions

diff --git a/lib/chef/resource/scm/_scm.rb b/lib/chef/resource/scm/_scm.rb
index ddb6619cab..c939246ba1 100644
--- a/lib/chef/resource/scm/_scm.rb
+++ b/lib/chef/resource/scm/_scm.rb
@@ -25,17 +25,18 @@ property :destination, String,
   description: "The location path to which the source is to be cloned, checked out, or exported. Default value: the name of the resource block.",
   name_property: true
 
-property :repository, String
+property :repository, String,
+  description: "The URI of the code repository."
 
 property :revision, String,
   description: "The revision to checkout.",
   default: "HEAD"
 
 property :user, [String, Integer],
-  description: "The system user that should own the checked-out code."
+  description: "The system user that will own the checked-out code."
 
 property :group, [String, Integer],
-  description: "The system group that should own the checked-out code."
+  description: "The system group that will own the checked-out code."
 
 property :timeout, Integer,
   description: "The amount of time (in seconds) to wait before timing out.",
diff --git a/lib/chef/resource/scm/subversion.rb b/lib/chef/resource/scm/subversion.rb
index 328a49072b..14360e9816 100644
--- a/lib/chef/resource/scm/subversion.rb
+++ b/lib/chef/resource/scm/subversion.rb
@@ -38,7 +38,7 @@ class Chef
         default: "--no-auth-cache"
 
       property :svn_info_args, [String, nil, FalseClass],
-        description: "Use when the svn info command is used by the #{Chef::Dist::CLIENT} and arguments need to be passed. The svn_arguments command does not work when the svn info command is used.",
+        description: "Use when the `svn info` command is used by #{Chef::Dist::PRODUCT} and arguments need to be passed. The `svn_arguments` command does not work when the `svn info` command is used.",
         coerce: proc { |v| v == false ? nil : v }, # coerce false to nil
         default: "--no-auth-cache"
 
diff --git a/lib/chef/resource/sudo.rb b/lib/chef/resource/sudo.rb
index 159291f41e..377e0e432e 100644
--- a/lib/chef/resource/sudo.rb
+++ b/lib/chef/resource/sudo.rb
@@ -88,15 +88,15 @@ class Chef
         default: lazy { [] }
 
       property :setenv, [TrueClass, FalseClass],
-        description: "Determines whether or not to permit preservation of the environment with 'sudo -E'.",
+        description: "Determines whether or not to permit preservation of the environment with `sudo -E`.",
         default: false
 
       property :env_keep_add, Array,
-        description: "An array of strings to add to env_keep.",
+        description: "An array of strings to add to `env_keep`.",
         default: lazy { [] }
 
       property :env_keep_subtract, Array,
-        description: "An array of strings to remove from env_keep.",
+        description: "An array of strings to remove from `env_keep`.",
         default: lazy { [] }
 
       property :visudo_path, String,
diff --git a/lib/chef/resource/swap_file.rb b/lib/chef/resource/swap_file.rb
index a39a05080d..7049b34ea7 100644
--- a/lib/chef/resource/swap_file.rb
+++ b/lib/chef/resource/swap_file.rb
@@ -39,7 +39,7 @@ class Chef
         default: false
 
       property :timeout, Integer,
-        description: "Timeout for 'dd' / 'fallocate' commands.",
+        description: "Timeout for `dd` / `fallocate` commands.",
         default: 600,
         desired_state: false
 
diff --git a/lib/chef/resource/systemd_unit.rb b/lib/chef/resource/systemd_unit.rb
index 031b58f3a7..8bb14be636 100644
--- a/lib/chef/resource/systemd_unit.rb
+++ b/lib/chef/resource/systemd_unit.rb
@@ -52,7 +52,7 @@ class Chef
                description: "The user account that the systemd unit process is run under. The path to the unit for that user would be something like '/etc/systemd/user/sshd.service'. If no user account is specified, the systemd unit will run under a 'system' account, with the path to the unit being something like '/etc/systemd/system/sshd.service'."
 
       property :content, [String, Hash],
-        description: "A string or hash that contains a systemd `unit file <https://www.freedesktop.org/software/systemd/man/systemd.unit.html>`_ definition that describes the properties of systemd-managed entities, such as services, sockets, devices, and so on. In #{Chef::Dist::PRODUCT} 14.4 or later, repeatable options can be implemented with an array."
+        description: "A string or hash that contains a systemd [unit file](https://www.freedesktop.org/software/systemd/man/systemd.unit.html) definition that describes the properties of systemd-managed entities, such as services, sockets, devices, and so on. In #{Chef::Dist::PRODUCT} 14.4 or later, repeatable options can be implemented with an array."
 
       property :triggers_reload, [TrueClass, FalseClass],
         description: "Specifies whether to trigger a daemon reload when creating or deleting a unit.",
diff --git a/lib/chef/resource/windows_dfs_folder.rb b/lib/chef/resource/windows_dfs_folder.rb
index 9cf3491654..9724d612e1 100644
--- a/lib/chef/resource/windows_dfs_folder.rb
+++ b/lib/chef/resource/windows_dfs_folder.rb
@@ -23,7 +23,7 @@ class Chef
     class WindowsDfsFolder < Chef::Resource
       provides :windows_dfs_folder
 
-      description "The windows_dfs_folder resources creates a folder within dfs as many levels deep as required."
+      description "Use the **windows_dfs_folder** resource to creates a folder within DFS as many levels deep as required."
       introduced "15.0"
 
       property :folder_path, String,
diff --git a/lib/chef/resource/windows_dfs_namespace.rb b/lib/chef/resource/windows_dfs_namespace.rb
index 19e43c8284..1293117e2b 100644
--- a/lib/chef/resource/windows_dfs_namespace.rb
+++ b/lib/chef/resource/windows_dfs_namespace.rb
@@ -23,7 +23,7 @@ class Chef
     class WindowsDfsNamespace < Chef::Resource
       provides :windows_dfs_namespace
 
-      description "Creates a share and DFS namespace on the local server."
+      description "Use the **windows_dfs_namespace** resource to creates a share and DFS namespace on a Windows server."
       introduced "15.0"
 
       property :namespace_name, String,
diff --git a/lib/chef/resource/windows_dfs_server.rb b/lib/chef/resource/windows_dfs_server.rb
index 2b9dfdcdd3..cb2bee1234 100644
--- a/lib/chef/resource/windows_dfs_server.rb
+++ b/lib/chef/resource/windows_dfs_server.rb
@@ -23,7 +23,7 @@ class Chef
     class WindowsDfsServer < Chef::Resource
       provides :windows_dfs_server
 
-      description "The windows_dfs_server resource sets system-wide DFS settings."
+      description "Use the **windows_dfs_server** resource to set system-wide DFS settings."
       introduced "15.0"
 
       property :use_fqdn, [TrueClass, FalseClass],