Add example of using rdoc-ref to link to file

jeremyevans · jeremyevans · commit 376715093d0a · 2025-08-06T16:01:35.000-07:00
diff --git a/doc/rdoc/markup_reference.rb b/doc/rdoc/markup_reference.rb
@@ -991,6 +991,7 @@
 #     generates baz[rdoc-ref:RDoc::MarkupReference#dummy_attribute].
 #   - Alias: <tt>bad[rdoc-ref:RDoc::MarkupReference#dummy_instance_alias]</tt>
 #     generates bad[rdoc-ref:RDoc::MarkupReference#dummy_instance_alias].
+#   - File: <tt>README[rdoc-ref:README.rdoc]</tt> generates README[rdoc-ref:README.rdoc].
 #
 #   If the referenced item does not exist, no link is generated
 #   and entire <tt>rdoc-ref:</tt> square-bracketed clause is removed

Original file line number	Diff line number	Diff line change
`@@ -991,6 +991,7 @@`
`991`	`991`	`# generates baz[rdoc-ref:RDoc::MarkupReference#dummy_attribute].`
`992`	`992`	`# - Alias: <tt>bad[rdoc-ref:RDoc::MarkupReference#dummy_instance_alias]</tt>`
`993`	`993`	`# generates bad[rdoc-ref:RDoc::MarkupReference#dummy_instance_alias].`
	`994`	`+# - File: <tt>README[rdoc-ref:README.rdoc]</tt> generates README[rdoc-ref:README.rdoc].`
`994`	`995`	`#`
`995`	`996`	`# If the referenced item does not exist, no link is generated`
`996`	`997`	`# and entire <tt>rdoc-ref:</tt> square-bracketed clause is removed`