summaryrefslogtreecommitdiff
path: root/doc/rdoc
AgeCommit message (Collapse)Author
2025-01-05[ruby/rdoc] [DOC] Remove unnecessary rdoc-ref missing exampleStan Lo
(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
2024-12-31[ruby/rdoc] Documentation for #1240Nobuyoshi Nakada
(https://github.com/ruby/rdoc/pull/1263) https://github.com/ruby/rdoc/commit/5dfccda4c0
2024-12-14[ruby/rdoc] Fix dead links in the markup reference pageStan Lo
(https://github.com/ruby/rdoc/pull/1242) https://github.com/ruby/rdoc/commit/d1cb9dc3c4
2024-12-05[ruby/rdoc] Deprecate `main` and `title` directivesStan Lo
(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-09-02[ruby/rdoc] [DOC] Fix links (https://github.com/ruby/rdoc/pull/1169)Burdette Lamar
https://github.com/ruby/rdoc/commit/a576ff890f
2024-07-29[ruby/rdoc] [DOC] Mods about markup formatsBurdette Lamar
(https://github.com/ruby/rdoc/pull/1143) https://github.com/ruby/rdoc/commit/011de3f2fd
2024-03-09[ruby/rdoc] [DOC] Improve documentation of include directive file searchPetrik de Heus
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-01-04[ruby/rdoc] Tweaks to Markup ReferenceBurdetteLamar
https://github.com/ruby/rdoc/commit/05ac6dba66
2024-01-02[ruby/rdoc] [DOC] MarkupReferenceBurdette Lamar
(https://github.com/ruby/rdoc/pull/1075) https://github.com/ruby/rdoc/commit/095b78123b
2023-12-25Typofix under doc directoryHiroshi SHIBATA
2023-12-18[DOC] Added notes regarding `:nodoc:` in C codeNobuyoshi Nakada
2023-06-16[ruby/rdoc] Fix missing closing colon for `:notnew:`zzak
https://github.com/ruby/rdoc/commit/1e550b7d02
2023-02-06[ruby/rdoc] Remove duplicate word in RDoc::MarkupReferencecjilbert504
The word "for" appeared twice in the same sentence in the margins section, and this PR removes the duplicate occurrence.
2023-02-05[ruby/rdoc] [DOC] Fix reference to proper list type RDoc::MarkupReferencecjilbert504
The "Lettered List" section referred to the previous "Numbered List" section, so this PR fixes that reference to point instead of lettered lists.
2022-08-16[ruby/rdoc] [DOC] Remove duplicated line in RDoc::MarkupReferencePeter Zhu
https://github.com/ruby/rdoc/commit/488f89aee4
2022-08-13[ruby/rdoc] [DOC] Enhances text about escapes ↵Burdette Lamar
(https://github.com/ruby/rdoc/pull/917) https://github.com/ruby/rdoc/commit/c40bac829c
2022-08-12[ruby/rdoc] Mods to section Text Markup (https://github.com/ruby/rdoc/pull/916)Burdette Lamar
https://github.com/ruby/rdoc/commit/5506d4d67e
2022-08-12[ruby/rdoc] Improvements to Text Markup examples ↵Burdette Lamar
(https://github.com/ruby/rdoc/pull/915) https://github.com/ruby/rdoc/commit/d00ddfe57c
2022-08-11[ruby/rdoc] [DOC] Make example formats explicit and consistent ↵Burdette Lamar
(https://github.com/ruby/rdoc/pull/913) https://github.com/ruby/rdoc/commit/7e6ef6c855
2022-08-11[ruby/rdoc] Treat text markup (italic, bold, monofont) as blocks ↵Burdette Lamar
(https://github.com/ruby/rdoc/pull/911) https://github.com/ruby/rdoc/commit/dc88f1b425
2022-08-07[ruby/rdoc] [DOC] Removes remaining old Markup Reference ↵Burdette Lamar
(https://github.com/ruby/rdoc/pull/910) https://github.com/ruby/rdoc/commit/4e44c9c6cf
2022-07-29[ruby/rdoc] Add block quotes (https://github.com/ruby/rdoc/pull/907)Burdette Lamar
Also adjusts which blocks may be nested. https://github.com/ruby/rdoc/commit/dde1860441
2022-07-28[ruby/rdoc] [DOC] Add some links in intro; delimit rendered HTML output. ↵Burdette Lamar
(https://github.com/ruby/rdoc/pull/904) https://github.com/ruby/rdoc/commit/c02645364f
2022-07-27[ruby/rdoc] [DOC] Clarifications for directives ↵Burdette Lamar
(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-26[ruby/rdoc] Move section Directives into section Blocks ↵Burdette Lamar
(https://github.com/ruby/rdoc/pull/901) https://github.com/ruby/rdoc/commit/e48e07ef53
2022-07-26* append newline at EOF. [ci skip]git
2022-07-25Sync RDocPeter Zhu
Notes: Merged: https://github.com/ruby/ruby/pull/6182