From 5d8d9754340ae05e596310a951ec3f6f74bb4a07 Mon Sep 17 00:00:00 2001 From: dave Date: Sat, 4 Dec 2004 05:38:17 +0000 Subject: Ignore leading and trailing lines in :section: blocks git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@7455 b2dd03c8-39d4-4d8f-98ff-823fe69b080e --- lib/rdoc/README | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) (limited to 'lib/rdoc/README') diff --git a/lib/rdoc/README b/lib/rdoc/README index 583f7f3b0c..60650dd88b 100644 --- a/lib/rdoc/README +++ b/lib/rdoc/README @@ -427,7 +427,17 @@ this margin are formatted verbatim. :section: is used as the section heading, and the remainder of the comment containing the section is used as introductory text. Subsequent methods, aliases, attributes, - and classes will be documented in this section. + and classes will be documented in this section. A :section: + comment block may have one or more lines before the :section: + directive. These will be removed, and any identical lines at + the end of the block are also removed. This allows you to add + visual cues such as + + # ---------------------------------------- + # :section: My Section + # This is the section that I wrote. + # See it glisten in the noon-day sun. + # ---------------------------------------- [call-seq:] lines up to the next blank line in the comment are treated as -- cgit v1.2.3