Please review pull request #33: (maint) Add link to RDoc markup document in Style Guide opened by (jeffmccune)
Description:
Without this patch the style guide gives an example of the inline puppet
manifest documentation but does not mention the markup format is RDoc.
This patch makes it clear module authors should specifically write
inline documentation in RDoc and provides a reference link to where to
learn about the syntax of the RDoc markup.
It also makes it clear why this is important; to automatically generate
documentation using puppet doc.
- Opened: Thu Dec 08 21:13:08 UTC 2011
- Based on: puppetlabs:master (03cdefc06bd849259c9b043e843602e5aae54677)
- Requested merge: jeffmccune:fixup/master/rdoc_in_style_guide (9b7f5a99ff558fef17048e72299ccf1f5d65e6a0)
Diff follows:
diff --git a/source/guides/style_guide.markdown b/source/guides/style_guide.markdown index 96ec4a3..e900d03 100644 --- a/source/guides/style_guide.markdown +++ b/source/guides/style_guide.markdown @@ -755,8 +755,12 @@ limited, stand alone manner. ## 13. Puppet Doc -Classes and defined resource types should be documented inline using the -following conventions: +Classes and defined resource types should be documented inline using +[RDoc markup](http://links.puppetlabs.com/rdoc_markup). These inline +documentation comments are important because online documentation can then be +easily generated using the +[puppet doc](http://links.puppetlabs.com/puppet_manifest_documentation) +command. For classes:
-- You received this message because you are subscribed to the Google Groups "Puppet Developers" 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-dev?hl=en.
