Skip to content

Commit 5dfccda

Browse files
authored
Documentation for #1240 (#1263)
1 parent 40dbbb4 commit 5dfccda

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

doc/rdoc/markup_reference.rb

+9
Original file line numberDiff line numberDiff line change
@@ -859,6 +859,15 @@
859859
# - On-page: <tt>DummyClass</tt> links to DummyClass.
860860
# - Off-page: <tt>RDoc::Alias</tt> links to RDoc::Alias.
861861
#
862+
# Note: For poeple want to mark up code (such as class, module,
863+
# constant, and method) as "<tt>+code+</tt>" (for interoperability
864+
# with other MarkDown parsers mainly), such word that refers a known
865+
# code object and is marked up entirely and separately as "monofont"
866+
# is also converted to a link.
867+
#
868+
# - <tt>+DummyClass+</tt> links to DummyClass
869+
# - <tt>+DummyClass-object+</tt> is not a link.
870+
#
862871
# [Module]
863872
#
864873
# - On-page: <tt>DummyModule</tt> links to DummyModule.

0 commit comments

Comments
 (0)