lib/puppet-doc-lint/result.rb in puppet-doc-lint-0.2.0 vs lib/puppet-doc-lint/result.rb in puppet-doc-lint-0.3.0
- old
+ new
@@ -21,12 +21,14 @@
def result_report
puts "===================================="
puts "Class #{class_name} ( #{file_name} )".bg_blue
puts "Parameters found #{parameters}"
if no_documentation
- puts "No documentation found."
- puts "If there is documentation, this may be a bug with the Puppet parser"
- puts "Puppet files with newer features such as the use of hashes can cause this\n\n"
+ puts "No documentation found.".red
+ puts "Possible reasons:"
+ puts "* The documentation is not formatted in the RDoc format"
+ puts "* There's a bug in the puppet documentation parser"
+ puts "* There is no documentation at all"
else
puts "Documented parameters found: #{documented_parameters}".green
puts "Undocumented parameters found: #{undocumented_parameters}".red
puts "Parameters with Documentation but no defintion: #{documented_parameter_no_assignment}".red unless documented_parameter_no_assignment.empty?
puts "Documentation Coverage: #{percent_documented}%"