summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTim Smith <tsmith@chef.io>2018-02-20 16:43:20 -0800
committerTim Smith <tsmith@chef.io>2018-02-21 14:10:24 -0800
commitce90cb1068fa9276a7fc7058fee7b148657bf940 (patch)
tree7d2af83c7244bddefae1310c415f8cf36d51e8c3
parentcfde76f8acd4eba3b6c9dfc014dff9b236aa1687 (diff)
downloadchef-perl.tar.gz
Update the docs to match the current docs site formatperl
Signed-off-by: Tim Smith <tsmith@chef.io>
-rw-r--r--lib/chef/resource/cpan_module.rb18
1 files changed, 9 insertions, 9 deletions
diff --git a/lib/chef/resource/cpan_module.rb b/lib/chef/resource/cpan_module.rb
index dde7a670f3..24030d713c 100644
--- a/lib/chef/resource/cpan_module.rb
+++ b/lib/chef/resource/cpan_module.rb
@@ -23,39 +23,39 @@ class Chef
resource_name :cpan_module
provides :cpan_module
- description "A resource for installing and uninstalling perl CPAN modules."
+ description "Use the cpan_module resource to install or uninstall perl CPAN modules."
introduced "14.0"
property :module_name,
String,
- description: "The name of the module if it's different than the name of the resource",
+ description: "The name of the module if it's different than the name of the resource.",
name_property: true
property :force,
[TrueClass, FalseClass],
- description: "To force the install within cpanm",
+ description: "To force the install within cpanm.",
default: false
property :test,
[TrueClass, FalseClass],
- description: "To do a test install",
+ description: "To do a test install.",
default: false
property :version,
String,
- description: "Any version string cpanm would find acceptable"
+ description: "Any version string cpanm would find acceptable."
property :cwd,
String,
- description: "A path to change into before running cpanm"
+ description: "A path to change into before running cpanm."
property :cpanm_binary,
String,
- description: "The path of the cpanm binary",
+ description: "The path of the cpanm binary.",
default: "cpanm"
action :install do
- description "Install the module"
+ description "Install the module."
declare_resource(:execute, "CPAN :install #{new_resource.module_name}") do
cwd current_working_dir
@@ -66,7 +66,7 @@ class Chef
end
action :uninstall do
- description "Uninstall the module"
+ description "Uninstall the module."
declare_resource(:execute, "CPAN :uninstall #{new_resource.module_name}") do
cwd current_working_dir