summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorBurdette Lamar <BurdetteLamar@Yahoo.com>2023-08-11 16:53:53 -0500
committerGitHub <noreply@github.com>2023-08-11 17:53:53 -0400
commit6ccc660d857e9e2275ce4b820291b79904821899 (patch)
tree4933571be521575913d3439459ebb6208baa60e0 /doc
parent58424787fc5db65245471940e03241444d10f071 (diff)
[DOC] Don't suppress autolinks (#8207)
Notes
Notes: Merged-By: peterzhu2118 <peter@peterzhu.ca>
Diffstat (limited to 'doc')
-rw-r--r--doc/contributing/documentation_guide.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/contributing/documentation_guide.md b/doc/contributing/documentation_guide.md
index ccfc7be294..5d5e9e6461 100644
--- a/doc/contributing/documentation_guide.md
+++ b/doc/contributing/documentation_guide.md
@@ -164,6 +164,12 @@ We might consider whether to suppress when:
(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.
### HTML Tags