path: root/lib/rdoc/README
diff options
Diffstat (limited to 'lib/rdoc/README')
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