The Puppet Labs Issue Tracker has Moved: https://tickets.puppetlabs.com

Feature #3381

puppetdoc doesn't generate documentation for modifications of resource properties

Added by Florian Wagner about 4 years ago. Updated about 4 years ago.

Status:AcceptedStart date:03/17/2010
Priority:NormalDue date:
Assignee:Brice Figureau% Done:

0%

Category:-
Target version:-
Affected Puppet version:0.25.4 Branch:
Keywords:

We've Moved!

Ticket tracking is now hosted in JIRA: https://tickets.puppetlabs.com

This ticket may be automatically exported to the PUP project on JIRA using the button below:


Description

When using puppetdoc to document classes which redefine some part of a resource these entries get no documentation generated:

class a {

# doc a

file { “/abc”:

mode => 775,

} }

class b {

# doc b

File[“/abc”] {

mode => 664,

} }

class c {

# doc c

File[“/abc”] {

owner => root,                                                             

} }

Only class a will get an entry for the “/abc” file. Classes b and c get no documentation entries about the extension or redefinition of properties of “/abc”.

History

#1 Updated by Brice Figureau about 4 years ago

  • Tracker changed from Bug to Feature
  • Status changed from Unreviewed to Accepted
  • Assignee set to Brice Figureau

Defaults and/or override are not parsed in the current version. Resource parsing wasn’t even planned in the first instance (ie I considered those as internal private information) and only classes and definitions were documented. I’m accepting the feature request, but it is unplanned for the moment.

Also available in: Atom PDF