Browse files

Clarify section order requirement. Closes #25.

  • Loading branch information...
1 parent 4bef056 commit a07d8ee610e20a9d5e90b38cc56d6d7ada8bd093 @mojombo committed May 7, 2012
Showing with 5 additions and 5 deletions.
  1. +5 −5 tomdoc.md
View
10 tomdoc.md
@@ -54,11 +54,11 @@ format:
TomDoc for a specific method consists of a block of single comment markers (#)
that appears directly above the method. There SHOULD NOT be a blank line
between the comment block and the method definition. A TomDoc method block
-consists of six optional sections: a description section, an arguments
-section, a yields section, an examples section, a returns section, and a
-signature section. Lines that contain text MUST be separated from the comment
-marker by a single space. Lines that do not contain text SHOULD consist of
-just a comment marker (no trailing spaces).
+consists of six optional sections: a description section, an arguments section,
+a yields section, an examples section, a returns section, and a signature
+section. Sections MUST appear in the order listed above. Lines that contain
+text MUST be separated from the comment marker by a single space. Lines that do
+not contain text SHOULD consist of just a comment marker (no trailing spaces).
<a name="description" />

0 comments on commit a07d8ee

Please sign in to comment.