summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorBurdette Lamar <BurdetteLamar@Yahoo.com>2023-08-23 09:09:24 -0500
committerGitHub <noreply@github.com>2023-08-23 10:09:24 -0400
commit448ff162c49bb5b27060d4551c5ded6ba768b5dd (patch)
tree6178d89703fa754d9445fd0af97773924b7cd82b /doc
parent129663c4a8e1522a862a26b99e997854186bafac (diff)
[DOC] Adding font usage to doc guide (#8255)
Notes
Notes: Merged-By: peterzhu2118 <peter@peterzhu.ca>
Diffstat (limited to 'doc')
-rw-r--r--doc/contributing/documentation_guide.md42
1 files changed, 38 insertions, 4 deletions
diff --git a/doc/contributing/documentation_guide.md b/doc/contributing/documentation_guide.md
index 5d5e9e6461..6cb2b8d7dc 100644
--- a/doc/contributing/documentation_guide.md
+++ b/doc/contributing/documentation_guide.md
@@ -127,7 +127,14 @@ a #=> [2, 3, 1]
### Headings
-Organize a long discussion with [headings](rdoc-ref:RDoc::MarkupReference@Headings).
+Organize a long discussion for a class or module with [headings](rdoc-ref:RDoc::MarkupReference@Headings).
+
+Do not use formal headings in the documentation for a method or constant.
+
+In the rare case where heading-like structures are needed
+within the documentation for a method or constant, use
+[bold text](rdoc-ref:RDoc::MarkupReference@Bold)
+as pseudo-headings.
### Blank Lines
@@ -151,6 +158,14 @@ For a method name in text:
or a hash mark for an instance method:
<tt>Foo.bar</tt>, <tt>Foo#baz</tt>.
+### Embedded Code and Commands
+
+Code or commands embedded in running text (i.e., not in a code block)
+should marked up as
+[monofont](rdoc-ref:RDoc::MarkupReference@Monofont).
+
+Code that is a simple string should include the quote marks.
+
### Auto-Linking
In general, \RDoc's auto-linking should not be suppressed.
@@ -167,9 +182,28 @@ We might consider whether to suppress when:
- The reference is to a class or module that users
usually don't deal with, including these:
- - \Class.
- - \Method.
- - \Module.
+ - \Class.
+ - \Method.
+ - \Module.
+
+Most often, the name of a class, module, or method
+will be autolinked:
+
+- Array.
+- Enumerable.
+- File.new
+- File#read.
+
+If not, or if you suppress autolinking, consider forcing
+[monofont](rdoc-ref:RDoc::MarkupReference@Monofont).
+
+### Variable Names
+
+The name of a variable (as specified in its call-seq) should be marked up as
+[monofont](rdoc-ref:RDoc::MarkupReference@Monofont).
+
+Also, use monofont text for the name of a transient variable
+(i.e., one defined and used only in the discussion, such as +n+).
### HTML Tags