Docs: Update documentation of stdlib classes

This commit edits the puppetdoc text of the stdlib and stdlib::stages classes
to remove redundancy and add additional information.

diff --git a/manifests/init.pp b/manifests/init.pp
index c80456892b8845e05b4ab7487bc47800a1d2cc9c..500ad770d53857ff4ff390fc6a8bb34389eb231f 100644 (file)
--- a/manifests/init.pp
+++ b/manifests/init.pp
@@ -1,16 +1,18 @@
 # Class: stdlib
 #
-# This module manages stdlib
+# This module manages stdlib. Most of stdlib's features are automatically
+# loaded by Puppet, but this class should be declared in order to use the
+# standardized run stages.
 #
-# Parameters:
+# Parameters: none
 #
 # Actions:
 #
-# Requires:
+#   Declares all other classes in the stdlib module. Currently, this consists
+#   of stdlib::stages.
 #
-# Sample Usage:
+# Requires: nothing
 #
-# [Remember: No empty lines between comments and class definition]
 class stdlib {
 
   class { 'stdlib::stages': }

diff --git a/manifests/stages.pp b/manifests/stages.pp
index 365b90558663791c8b54556b2a38e3e4931f1211..eb15fd650d0bea3c8bbbdb54ff551e5c6f514bc5 100644 (file)
--- a/manifests/stages.pp
+++ b/manifests/stages.pp
@@ -1,8 +1,9 @@
 # Class: stdlib::stages
 #
-# This class manages a standard set of Run Stages for Puppet.
+# This class manages a standard set of run stages for Puppet. It is managed by
+# the stdlib class, and should not be declared independently.
 #
-# The high level stages are (In order):
+# The high level stages are (in order):
 #
 #  * setup
 #  * main
@@ -13,19 +14,19 @@
 #  * deploy_app
 #  * deploy
 #
-# Parameters:
+# Parameters: none
 #
 # Actions:
 #
 #   Declares various run-stages for deploying infrastructure,
 #   language runtimes, and application layers.
 #
-# Requires:
+# Requires: nothing
 #
 # Sample Usage:
 #
 #  node default {
-#    include stdlib::stages
+#    include stdlib
 #    class { java: stage => 'runtime' }
 #  }
 #