diff options
| author | Nobuyoshi Nakada <nobu@ruby-lang.org> | 2024-01-01 14:43:26 +0900 |
|---|---|---|
| committer | Nobuyoshi Nakada <nobu@ruby-lang.org> | 2024-01-02 10:15:43 +0900 |
| commit | 84eeb83f367e30c99e862a786e6fa6d21d8019e8 (patch) | |
| tree | b027fa111af1cb8b8bfd4f950efa9d341ae6ff5e | |
| parent | 5993d0f5f2e792b354955ae70442e66f7b31fb78 (diff) | |
| download | ruby-84eeb83f367e30c99e862a786e6fa6d21d8019e8.tar.gz | |
[DOC] Stop using `:enddoc:` in rdoc files
In rdoc files, all documents belong to the top level of each file, and
`:enddoc:` turns off `#document_self` for the entire document in the
current file. This disables cross-references to labels in that file.
Instead use `:stopdoc:` so that parsing can re-start by `:startdoc:`
after the local variables.
| -rw-r--r-- | doc/extension.ja.rdoc | 8 | ||||
| -rw-r--r-- | doc/extension.rdoc | 7 |
2 files changed, 8 insertions, 7 deletions
diff --git a/doc/extension.ja.rdoc b/doc/extension.ja.rdoc index b0760dc149..052bf727b2 100644 --- a/doc/extension.ja.rdoc +++ b/doc/extension.ja.rdoc @@ -1863,7 +1863,7 @@ Ruby 3.0 から、Ruby プログラムを並列に実行するための仕組み Ractor をサポートするための詳細は、extension.rdoc の「Appendix F. Ractor support」を参照してください。 - -:enddoc: Local variables: -:enddoc: fill-column: 60 -:enddoc: end: +:stopdoc: Local variables: +:stopdoc: fill-column: 60 +:stopdoc: end: +:startdoc: diff --git a/doc/extension.rdoc b/doc/extension.rdoc index db4145ca18..9e71b7f428 100644 --- a/doc/extension.rdoc +++ b/doc/extension.rdoc @@ -2274,6 +2274,7 @@ There are possibly other points or requirements which must be considered in the making of a Ractor-safe extension. This document will be extended as they are discovered. -:enddoc: Local variables: -:enddoc: fill-column: 70 -:enddoc: end: +:stopdoc: Local variables: +:stopdoc: fill-column: 70 +:stopdoc: end: +:startdoc: |