Bug #11384

Hash in class parameter breaks doc generation

Added by Carlos Sanchez 5 months ago. Updated 3 months ago.

Status:Accepted Start date:12/14/2011
Priority:Low Due date:
Assignee:- % Done:

0%
Category:parser
Target version:-
Affected Puppet version:2.7.9 Branch:
Keywords:rdoc puppetdoc hash doc parameterized class
Votes: 5

Description

Having a hash in a class parameter makes the Class documentation to be discarded when running puppetdoc

Running puppet doc --mode rdoc --manifestdir test/manifests/test.pp --modulepath ./

test/manifests/test.pp

# Class: test
# 
# test class. This comment is ignored by puppetdoc
class test( $p = {} ) {
}

# Class: test2
# 
# test2 class. This comment is NOT ignored by puppetdoc
class test2() {
}

I tried to narrow it down and seems an issue at manifest parse time, as the klass.doc variable is already “” in puppet/util/rdoc/parser.rb

History

#1
Updated by Daniel Pittman 5 months ago

  • Status changed from Unreviewed to Accepted

Thanks for the report. I can reproduce the problem here; thanks for being so clear about how to reproduce the problem.

Also available in: Atom PDF