Issue #11801 has been updated by Kristof Willaert.
This ticket was created following a discussion in puppet pull request [#287](https://github.com/puppetlabs/puppet/pull/287#issuecomment-3363532), which was in turn created to fix issue [#11282](http://projects.puppetlabs.com/issues/11282). The two really belong together, since changing the README suffix in the module skeleton would now result in it not being parsed, and only allowing it to be parsed without changing the module skeleton accordingly would probably result in nobody being aware/using it. I have a small patch to fix this, will create a pull request as soon as possible. ---------------------------------------- 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: Unreviewed Priority: Normal Assignee: Category: 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.
