summaryrefslogtreecommitdiff
path: root/lib/rdoc/README
diff options
context:
space:
mode:
authordave <dave@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2004-07-12 12:20:51 +0000
committerdave <dave@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2004-07-12 12:20:51 +0000
commit70462a011e4ab3e4d19e4bdd8c17da7631c1b4b5 (patch)
treee4c9d9932aed19a801e6680bd8ffcfa40bbf8c8c /lib/rdoc/README
parent99f94a12159457f8717e4ed852a70f586fe51a8a (diff)
Allow multiple words in braces before a link
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/branches/ruby_1_8@6611 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'lib/rdoc/README')
-rw-r--r--lib/rdoc/README3
1 files changed, 2 insertions, 1 deletions
diff --git a/lib/rdoc/README b/lib/rdoc/README
index 6e234e31a5..e13ab87dc8 100644
--- a/lib/rdoc/README
+++ b/lib/rdoc/README
@@ -333,7 +333,8 @@ this margin are formatted verbatim.
Hyperlinks can also be of the form <tt>label</tt>[url], in which
case the label is used in the displayed text, and <tt>url</tt> is
- used as the target.
+ used as the target. If <tt>label</tt> contains multiple words,
+ put it in braces: <em>{multi word label}[</em>url<em>]</em>.
9. Method parameter lists are extracted and displayed with
the method description. If a method calls +yield+, then