Merge pull request puppetlabs#9497 from dotdash/tidy_recurse_docs

tidy: Clarify meaning of numeric `recurse` values
joshcooper · Oct 8, 2024 · 10486dd · 10486dd
2 parents 8fdde4e + 23e2b00
commit 10486dd
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/lib/puppet/type/tidy.rb b/lib/puppet/type/tidy.rb
@@ -32,7 +32,9 @@
 
   newparam(:recurse) do
     desc "If target is a directory, recursively descend
-      into the directory looking for files to tidy."
+      into the directory looking for files to tidy. Numeric values
+      specify a limit for the recursion depth, `true` means
+      unrestricted recursion."
 
     newvalues(:true, :false, :inf, /^[0-9]+$/)