From 4f1a466522bdab1fcac04c9d2246e15010467925 Mon Sep 17 00:00:00 2001 From: Burdette Lamar Date: Mon, 12 Feb 2024 14:01:46 -0600 Subject: [PATCH] More on auto-link (#9907) --- doc/contributing/documentation_guide.md | 20 +++++++------------- 1 file changed, 7 insertions(+), 13 deletions(-) diff --git a/doc/contributing/documentation_guide.md b/doc/contributing/documentation_guide.md index 027be34775..59953d0d52 100644 --- a/doc/contributing/documentation_guide.md +++ b/doc/contributing/documentation_guide.md @@ -173,23 +173,17 @@ Code that is a simple string should include the quote marks. In general, \RDoc's auto-linking should not be suppressed. For example, we should write `Array`, not `\Array`. -We might consider whether to suppress when: +However, suppress when the word in question: -- The word in question does not refer to a Ruby entity +- Does not refer to a Ruby entity (e.g., some uses of _Class_ or _English_). -- The reference is to the current class document - (e.g., _Array_ in the documentation for class `Array`). -- The same reference is repeated many times - (e.g., _RDoc_ on this page). -- The reference is to a class or module that users - usually don't deal with, including these: - - - \Class. - - \Method. - - \Module. +- Refers to the current document + (e.g., _Array_ in the documentation for class `Array`); + in that case, the word should be forced to + [monofont](rdoc-ref:RDoc::MarkupReference@Monofont). Most often, the name of a class, module, or method -will be autolinked: +will be auto-linked: - Array. - Enumerable.