Add recommendations on link formatting in documentation

This commit is contained in:
Burdette Lamar 2023-11-23 22:39:24 -06:00 коммит произвёл GitHub
Родитель 02cc9d48f1
Коммит 12f4e9655e
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
1 изменённых файлов: 30 добавлений и 0 удалений

Просмотреть файл

@ -199,6 +199,36 @@ will be autolinked:
If not, or if you suppress autolinking, consider forcing
[monofont](rdoc-ref:RDoc::MarkupReference@Monofont).
### Explicit Links
When writing an explicit link, follow these guidelines.
#### +rdoc-ref+ Scheme
Use the +rdoc-ref+ scheme for:
- A link in core documentation to other core documentation.
- A link in core documentation to documentation in a standard library package.
- A link in a standard library package to other documentation in that same
standard library package.
See section "+rdoc-ref+ Scheme" in {Links}[rdoc-ref:RDoc::MarkupReference@Links].
#### URL-Based Link
Use a full URL-based link for:
- A link in standard library documentation to documentation in the core.
- A link in standard library documentation to documentation in a different
standard library package.
Doing so ensures that the link will valid even when the package documentation
is built independently (separately from the core documentation).
The link should lead to a target in https://docs.ruby-lang.org/en/master/.
Also use a full URL-based link for a link to an off-site document.
### Variable Names
The name of a variable (as specified in its call-seq) should be marked up as