27 Commits

Author SHA1 Message Date
Stan Lo
e45fca1372 [ruby/rdoc] [DOC] Remove unnecessary rdoc-ref missing example
(https://github.com/ruby/rdoc/pull/1271)

We don't actually need to link to the missing item to show the non-linked
result.

https://github.com/ruby/rdoc/commit/a7b7e8fc55
2025-01-05 12:41:53 +00:00
Nobuyoshi Nakada
63b141ef21 [ruby/rdoc] Documentation for #1240
(https://github.com/ruby/rdoc/pull/1263)

https://github.com/ruby/rdoc/commit/5dfccda4c0
2024-12-31 12:16:50 +00:00
Stan Lo
792275e5f0 [ruby/rdoc] Fix dead links in the markup reference page
(https://github.com/ruby/rdoc/pull/1242)

https://github.com/ruby/rdoc/commit/d1cb9dc3c4
2024-12-14 12:12:45 +00:00
Stan Lo
2ecd2fe0ed [ruby/rdoc] Deprecate main and title directives
(https://github.com/ruby/rdoc/pull/1218)

* Deprecate :main: directive

* Deprecate :title: direcive

* Update documentation

* Remove :main: directive's usage

* Update test cases

* Add '.rdoc_options' to suggested alternatives

https://github.com/ruby/rdoc/commit/e2d4ac9dad
2024-12-05 11:36:34 +00:00
Burdette Lamar
b539b43b2b [ruby/rdoc] [DOC] Fix links (https://github.com/ruby/rdoc/pull/1169)
https://github.com/ruby/rdoc/commit/a576ff890f
2024-09-02 15:36:53 +00:00
Burdette Lamar
63bdf2d725 [ruby/rdoc] [DOC] Mods about markup formats
(https://github.com/ruby/rdoc/pull/1143)

https://github.com/ruby/rdoc/commit/011de3f2fd
2024-07-29 13:16:18 +00:00
Petrik de Heus
a69910211b [ruby/rdoc] [DOC] Improve documentation of include directive file search
Searching the file in the "current directory" could be read as the
directory from which RDoc is run. This is incorrect, as the file is
first searched in the directory containing the current documented file.

Also this directory is searched before the `--include` directories.

https://github.com/ruby/rdoc/commit/aa2d98ee5e
2024-03-09 05:46:49 +00:00
BurdetteLamar
10b9679fa6 [ruby/rdoc] Tweaks to Markup Reference
https://github.com/ruby/rdoc/commit/05ac6dba66
2024-01-04 21:27:58 +00:00
Burdette Lamar
a046d4efd2 [ruby/rdoc] [DOC] MarkupReference
(https://github.com/ruby/rdoc/pull/1075)

https://github.com/ruby/rdoc/commit/095b78123b
2024-01-02 14:00:31 +00:00
Hiroshi SHIBATA
c903cddf55
Typofix under doc directory 2023-12-25 11:17:51 +09:00
Nobuyoshi Nakada
a94f3f206e
[DOC] Added notes regarding :nodoc: in C code 2023-12-18 20:17:44 +09:00
zzak
80dfe2bc4d [ruby/rdoc] Fix missing closing colon for :notnew:
https://github.com/ruby/rdoc/commit/1e550b7d02
2023-06-16 08:54:12 +00:00
cjilbert504
a719e3418e [ruby/rdoc] Remove duplicate word in RDoc::MarkupReference
The word "for" appeared twice in the same sentence in the margins section, and this PR removes the duplicate occurrence.
2023-02-06 23:09:38 +00:00
cjilbert504
8a474b344e [ruby/rdoc] [DOC] Fix reference to proper list type RDoc::MarkupReference
The "Lettered List" section referred to the previous "Numbered List" section, so this PR fixes that reference to point instead of lettered lists.
2023-02-05 09:28:02 +00:00
Peter Zhu
4e66b3f47b [ruby/rdoc] [DOC] Remove duplicated line in RDoc::MarkupReference
https://github.com/ruby/rdoc/commit/488f89aee4
2022-08-16 02:48:04 +09:00
Burdette Lamar
fa65800ee5 [ruby/rdoc] [DOC] Enhances text about escapes (https://github.com/ruby/rdoc/pull/917)
https://github.com/ruby/rdoc/commit/c40bac829c
2022-08-13 09:00:18 +09:00
Burdette Lamar
5e3e4bc984 [ruby/rdoc] Mods to section Text Markup (https://github.com/ruby/rdoc/pull/916)
https://github.com/ruby/rdoc/commit/5506d4d67e
2022-08-12 05:09:02 +09:00
Burdette Lamar
8a3f401b24 [ruby/rdoc] Improvements to Text Markup examples (https://github.com/ruby/rdoc/pull/915)
https://github.com/ruby/rdoc/commit/d00ddfe57c
2022-08-12 01:43:43 +09:00
Burdette Lamar
c361cf44c0 [ruby/rdoc] [DOC] Make example formats explicit and consistent (https://github.com/ruby/rdoc/pull/913)
https://github.com/ruby/rdoc/commit/7e6ef6c855
2022-08-11 22:51:09 +09:00
Burdette Lamar
9fc401b689 [ruby/rdoc] Treat text markup (italic, bold, monofont) as blocks (https://github.com/ruby/rdoc/pull/911)
https://github.com/ruby/rdoc/commit/dc88f1b425
2022-08-11 06:18:39 +09:00
Burdette Lamar
23a84d53c6 [ruby/rdoc] [DOC] Removes remaining old Markup Reference (https://github.com/ruby/rdoc/pull/910)
https://github.com/ruby/rdoc/commit/4e44c9c6cf
2022-08-07 21:07:23 +09:00
Burdette Lamar
f78e46d404 [ruby/rdoc] Add block quotes (https://github.com/ruby/rdoc/pull/907)
Also adjusts which blocks may be nested.

https://github.com/ruby/rdoc/commit/dde1860441
2022-07-29 23:40:26 +09:00
Burdette Lamar
18b1e5e6db [ruby/rdoc] [DOC] Add some links in intro; delimit rendered HTML output. (https://github.com/ruby/rdoc/pull/904)
https://github.com/ruby/rdoc/commit/c02645364f
2022-07-28 23:50:49 +09:00
Burdette Lamar
64f9f7d855 [ruby/rdoc] [DOC] Clarifications for directives (https://github.com/ruby/rdoc/pull/903)
-  Former section "Directives in Trailing Comments" is reworked. The important thing about a directive is what it does, not whether it's trailing or stand-alone. Therefore I've worked the directives in the former section into the appropriate sections, based on function.
- Each directive is now explicitly marked as trailing or stand-alone.
- C-code directives are mentioned only for those directives that actually appear in our ruby/ruby C files, which are :startdoc:, :stopdoc:, :enddoc:, :include:, and :call-seq:. What effect, if any, other directives have in C, I'm not sure about.

https://github.com/ruby/rdoc/commit/b00978bfa5
2022-07-27 05:06:56 +09:00
Burdette Lamar
cc29b43c7a [ruby/rdoc] Move section Directives into section Blocks (https://github.com/ruby/rdoc/pull/901)
https://github.com/ruby/rdoc/commit/e48e07ef53
2022-07-26 06:31:36 +09:00
git
d7868c79e2 * append newline at EOF. [ci skip] 2022-07-26 05:29:28 +09:00
Peter Zhu
ba098fa151 Sync RDoc 2022-07-25 16:29:14 -04:00