Skip to content

Commit fa2fde6

Browse files
committed
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.
1 parent 0594aa9 commit fa2fde6

File tree

2 files changed

+13
-10
lines changed

2 files changed

+13
-10
lines changed

manifests/init.pp

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,18 @@
11
# Class: stdlib
22
#
3-
# This module manages stdlib
3+
# This module manages stdlib. Most of stdlib's features are automatically
4+
# loaded by Puppet, but this class should be declared in order to use the
5+
# standardized run stages.
46
#
5-
# Parameters:
7+
# Parameters: none
68
#
79
# Actions:
810
#
9-
# Requires:
11+
# Declares all other classes in the stdlib module. Currently, this consists
12+
# of stdlib::stages.
1013
#
11-
# Sample Usage:
14+
# Requires: nothing
1215
#
13-
# [Remember: No empty lines between comments and class definition]
1416
class stdlib {
1517

1618
class { 'stdlib::stages': }

manifests/stages.pp

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
# Class: stdlib::stages
22
#
3-
# This class manages a standard set of Run Stages for Puppet.
3+
# This class manages a standard set of run stages for Puppet. It is managed by
4+
# the stdlib class, and should not be declared independently.
45
#
5-
# The high level stages are (In order):
6+
# The high level stages are (in order):
67
#
78
# * setup
89
# * main
@@ -13,19 +14,19 @@
1314
# * deploy_app
1415
# * deploy
1516
#
16-
# Parameters:
17+
# Parameters: none
1718
#
1819
# Actions:
1920
#
2021
# Declares various run-stages for deploying infrastructure,
2122
# language runtimes, and application layers.
2223
#
23-
# Requires:
24+
# Requires: nothing
2425
#
2526
# Sample Usage:
2627
#
2728
# node default {
28-
# include stdlib::stages
29+
# include stdlib
2930
# class { java: stage => 'runtime' }
3031
# }
3132
#

0 commit comments

Comments
 (0)