(#11801) puppet doc uses README.rdoc in toplevel module dir#309
(#11801) puppet doc uses README.rdoc in toplevel module dir#309willaerk wants to merge 1 commit intopuppetlabs:masterfrom willaerk:tickets/2.7.x/11801_puppet_doc_include_readme_rdoc
Conversation
|
This was deselected compared to #380, which is the same thing, but had tests. |
|
Fair enough, I guess I'll have to read up on RSpec ;) |
|
@willaerk - it isn't strictly required, though we obviously prefer things come in with tests. They help illuminate why this fixes the problem, and help stop us breaking it again. :) The other practical advantage, of course, is that because we want tests for every commit to address those issues, if your submission doesn't have them we have to take the time to write them - which makes it harder work to get your code in, so other changes tend to merge ahead of it. What we are, though, is absolutely willing to spend time working with you to help you get tests written. That is a win for everyone. :) (...and we totally don't reject things without tests, unless this circumstance comes up: someone else submits a fix for the same problem with tests. :) |
Removed erroneous spaces from ENC curl script.
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.
It seems to make sense to rename README to README.rdoc, to clarify the expectation of puppet doc and avoid confusion about the preferred markup .
The patch adds README.rdoc to the files to be scanned for RDoc directives.