Update yes_arg description

puppetlabs · Jun 27, 2023 · 3385a26 · 3385a26
1 parent 967af55
commit 3385a26
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -201,7 +201,7 @@ resources out yourself.
 * stripesize (Parameter) - The stripesize to use for the new logical volume.
 * thinpool (Parameter) - Default value: `false` - Set to true to create a thin pool or to pool name to create thin volume
 * volume_group (Parameter) - The volume group name associated with this logical volume. This will automatically set this volume group as a dependency, but it must be defined elsewhere using the volume_group resource type.
-* yes_flag (Parameter) - Default value: `false` - Do not prompt for confirmation interactively but always assume the answer yes.
+* yes_flag (Parameter) - Default value: `false` - If set to true, do not prompt for confirmation interactively but always assume the answer yes.
 
 ### physical_volume
 

diff --git a/lib/puppet/type/logical_volume.rb b/lib/puppet/type/logical_volume.rb
@@ -181,7 +181,7 @@ def insync?(is)
   end
 
   newparam(:yes_flag) do
-    desc "Do not prompt for confirmation interactively but always assume the answer yes."
+    desc "If set to true, do not prompt for confirmation interactively but always assume the answer yes."
     defaultto false
   end
 

diff --git a/tasks/ensure_lv.json b/tasks/ensure_lv.json
@@ -82,7 +82,7 @@
       "type": "Optional[Integer]"
     },
     "yes_flag": {
-      "description": "Do not prompt for confirmation interactively but always assume the answer yes.",
+      "description": "If set to true, do not prompt for confirmation interactively but always assume the answer yes.",
       "type": "Optional[Boolean]"
     }
   }