Skip to content

Commit 3f3a79f

Browse files
committed
Mention improved section support in RDoc::Markup
1 parent 431baa1 commit 3f3a79f

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

lib/rdoc/markup.rb

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -502,18 +502,22 @@
502502
# Starts a new section in the output. The title following +:section:+ is
503503
# used as the section heading, and the remainder of the comment containing
504504
# the section is used as introductory text. Subsequent methods, aliases,
505-
# attributes, and classes will be documented in this section. A :section:
506-
# comment block may have one or more lines before the :section: directive.
507-
# These will be removed, and any identical lines at the end of the block are
508-
# also removed. This allows you to add visual cues such as:
505+
# attributes, and classes will be documented in this section.
506+
#
507+
# A :section: comment block may have one or more lines before the :section:
508+
# directive. These will be removed, and any identical lines at the end of
509+
# the block are also removed. This allows you to add visual cues such as:
509510
#
510511
# # ----------------------------------------
511512
# # :section: My Section
512513
# # This is the section that I wrote.
513514
# # See it glisten in the noon-day sun.
514515
# # ----------------------------------------
515516
#
516-
# <i>Note: Current formatters to not take sections into account.</i>
517+
# Sections may be referenced multiple times in a class or module allowing
518+
# methods, attributes and constants to be ordered one way for implementation
519+
# ordering but still grouped together in documentation. If a section has
520+
# multiple comments they will be concatenated with a dividing rule.
517521
#
518522
# [+:call-seq:+]
519523
# Lines up to the next blank line in the comment are treated as the method's

0 commit comments

Comments
 (0)