Merge pull request #195 from ghoneycutt/gh192_fix_documentation_style

(GH-192) Fix puppet-strings description of class and defined type
puppetlabs · Mar 4, 2019 · adcb444 · adcb444
2 parents 01199f0 + 562ebc3
commit adcb444
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/object_templates/class.erb b/object_templates/class.erb
@@ -1,7 +1,7 @@
-# A description of what this class does
-#
 # @summary A short summary of the purpose of this class
 #
+# A description of what this class does
+#
 # @example
 # include <%= name %>
 <%- if params -%>

diff --git a/object_templates/defined_type.erb b/object_templates/defined_type.erb
@@ -1,7 +1,7 @@
-# A description of what this defined type does
-#
 # @summary A short summary of the purpose of this defined type.
 #
+# A description of what this defined type does
+#
 # @example
 # <%= name %> { 'namevar': }
 define <%= name %> (