[DOC] Correction for doc guide + TOC fix in File (#8505)

This commit is contained in:
Burdette Lamar 2023-09-24 16:57:21 -05:00 committed by GitHub
parent f43dac0df2
commit 36cd2b2a52
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 14 additions and 9 deletions

View File

@ -216,16 +216,21 @@ may not render them properly.
In particular, avoid building tables with HTML tags
(<tt><table></tt>, etc.).
Alternatives are:
- The GFM (GitHub Flavored Markdown) table extension,
which is enabled by default. See
{GFM tables extension}[https://github.github.com/gfm/#tables-extension-].
Alternatives:
- A {verbatim text block}[rdoc-ref:RDoc::MarkupReference@Verbatim+Text+Blocks],
using spaces and punctuation to format the text.
Note that {text markup}[rdoc-ref:RDoc::MarkupReference@Text+Markup]
will not be honored.
using spaces and punctuation to format the text;
note that {text markup}[rdoc-ref:RDoc::MarkupReference@Text+Markup]
will not be honored:
- Example {source}[https://github.com/ruby/ruby/blob/34d802f32f00df1ac0220b62f72605827c16bad8/file.c#L6570-L6596].
- Corresponding {output}[rdoc-ref:File@Read-2FWrite+Mode].
- (Markdown format only): A {Github Flavored Markdown (GFM) table}[https://github.github.com/gfm/#tables-extension-],
using special formatting for the text:
- Example {source}[https://github.com/ruby/ruby/blob/34d802f32f00df1ac0220b62f72605827c16bad8/doc/contributing/glossary.md?plain=1].
- Corresponding {output}[https://docs.ruby-lang.org/en/master/contributing/glossary_md.html].
## Documenting Classes and Modules

2
file.c
View File

@ -6531,7 +6531,7 @@ const char ruby_null_device[] =
* \Class \File extends module FileTest, supporting such singleton methods
* as <tt>File.exist?</tt>.
*
* === About the Examples
* == About the Examples
*
* Many examples here use these variables:
*