Issue #11801 has been updated by Daniel Pittman. Category set to documentation Status changed from Unreviewed to In Topic Branch Pending Review
---------------------------------------- Feature #11801: puppet doc should be able to use README.rdoc in toplevel module dir https://projects.puppetlabs.com/issues/11801 Author: Kristof Willaert Status: In Topic Branch Pending Review Priority: Normal Assignee: Category: documentation Target version: Affected Puppet version: Keywords: Branch: The README in the toplevel module dir gets integrated in the RDoc documentation as created by `puppet doc`. If it contains RDoc markup, it will be processed and rendered as the rest of the module documentation. So, to me it would make sense to rename the README to README.rdoc, to clarify the expectation of puppet doc and avoid confusion about the preferred markup . This would also require a change to `lib/puppet/util/rdoc/parser.rb`, since now it is only looking for a "README". -- You have received this notification because you have either subscribed to it, or are involved in it. To change your notification preferences, please click here: http://projects.puppetlabs.com/my/account -- You received this message because you are subscribed to the Google Groups "Puppet Bugs" group. To post to this group, send email to [email protected]. To unsubscribe from this group, send email to [email protected]. For more options, visit this group at http://groups.google.com/group/puppet-bugs?hl=en.
