<feed xmlns='http://www.w3.org/2005/Atom'>
<title>ruby.git/lib/rdoc/markup, branch v3_4_9</title>
<subtitle>The Ruby Programming Language</subtitle>
<link rel='alternate' type='text/html' href='https://git.ruby-lang.org/ruby.git/'/>
<entry>
<title>Sync RDoc 6.14.0</title>
<updated>2025-05-22T22:04:47+00:00</updated>
<author>
<name>Stan Lo</name>
<email>stan.lo@shopify.com</email>
</author>
<published>2025-05-22T21:49:04+00:00</published>
<link rel='alternate' type='text/html' href='https://git.ruby-lang.org/ruby.git/commit/?id=03eb777c69d64aa4941891a784c1fd67b44ea42c'/>
<id>03eb777c69d64aa4941891a784c1fd67b44ea42c</id>
<content type='text'>
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
</pre>
</div>
</content>
</entry>
<entry>
<title>[ruby/rdoc] Enable cross reference in code</title>
<updated>2024-12-17T21:48:31+00:00</updated>
<author>
<name>Nobuyoshi Nakada</name>
<email>nobu@ruby-lang.org</email>
</author>
<published>2024-12-17T21:48:27+00:00</published>
<link rel='alternate' type='text/html' href='https://git.ruby-lang.org/ruby.git/commit/?id=fef8ecc708e0dbb5725abb1aa24329cf612f8c41'/>
<id>fef8ecc708e0dbb5725abb1aa24329cf612f8c41</id>
<content type='text'>
(https://github.com/ruby/rdoc/pull/1240)

Some people like to mark up method names in MarkDown style block
quotes, like this: ruby/ruby#12333.
Currently, no links are created in the code in the RDoc, but such
words most likely refer to methods.
This PR makes a word a code cross-reference if the whole word can be
resolved as a reference.

https://github.com/ruby/rdoc/commit/7d7efb0709
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
(https://github.com/ruby/rdoc/pull/1240)

Some people like to mark up method names in MarkDown style block
quotes, like this: ruby/ruby#12333.
Currently, no links are created in the code in the RDoc, but such
words most likely refer to methods.
This PR makes a word a code cross-reference if the whole word can be
resolved as a reference.

https://github.com/ruby/rdoc/commit/7d7efb0709
</pre>
</div>
</content>
</entry>
<entry>
<title>[ruby/rdoc] `aligns` may include `:center`</title>
<updated>2024-12-17T20:56:24+00:00</updated>
<author>
<name>Soutaro Matsumoto</name>
<email>matsumoto@soutaro.com</email>
</author>
<published>2024-12-17T20:56:21+00:00</published>
<link rel='alternate' type='text/html' href='https://git.ruby-lang.org/ruby.git/commit/?id=408f5368908889e1af141b05d3afd8704b0ef33a'/>
<id>408f5368908889e1af141b05d3afd8704b0ef33a</id>
<content type='text'>
(https://github.com/ruby/rdoc/pull/1247)

https://github.com/ruby/rdoc/commit/cbbf04d6f8
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
(https://github.com/ruby/rdoc/pull/1247)

https://github.com/ruby/rdoc/commit/cbbf04d6f8
</pre>
</div>
</content>
</entry>
<entry>
<title>[ruby/rdoc] Print warnings for rdoc-ref links that can't be resolved</title>
<updated>2024-12-16T19:35:00+00:00</updated>
<author>
<name>Stan Lo</name>
<email>stan001212@gmail.com</email>
</author>
<published>2024-12-16T19:34:56+00:00</published>
<link rel='alternate' type='text/html' href='https://git.ruby-lang.org/ruby.git/commit/?id=a6fd6cb72f22531cc3cc976de99c5f9eccbf7101'/>
<id>a6fd6cb72f22531cc3cc976de99c5f9eccbf7101</id>
<content type='text'>
(https://github.com/ruby/rdoc/pull/1241)

https://github.com/ruby/rdoc/commit/4a5206ae56
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
(https://github.com/ruby/rdoc/pull/1241)

https://github.com/ruby/rdoc/commit/4a5206ae56
</pre>
</div>
</content>
</entry>
<entry>
<title>[ruby/rdoc] Use distinct styles for note lists and label lists</title>
<updated>2024-12-08T10:43:47+00:00</updated>
<author>
<name>nicholas a. evans</name>
<email>nick@rubinick.dev</email>
</author>
<published>2024-12-08T10:43:43+00:00</published>
<link rel='alternate' type='text/html' href='https://git.ruby-lang.org/ruby.git/commit/?id=dd43af3be7eddb832c77ef367456fa023fed7d7a'/>
<id>dd43af3be7eddb832c77ef367456fa023fed7d7a</id>
<content type='text'>
(https://github.com/ruby/rdoc/pull/1209)

* Use the original `label` description list style

As a default for all description lists, the original "label" style is
more readable.

This is slightly different from the original `label` dl though:
* slightly increased left margin for `dd` (to 1em)
* removed right margin on `dd`
* removed `dt` bottom margin and `dd` top margin, to reduce the gap
  between the term and its description (to only the standard line-height
  gap).

* Add closing tags for description list terms

Without the closing tags, the dt elements contain whitespace after the
text.  This normally isn't a big deal, but does mess some things up,
e.g: using `::after` with `content: ", "` in stylesheets.

* Restore float:left style for note lists

Unlike the original note list styles, this version sets the line-height
for all `dt` elements to be the same as the `p` elements contained
inside the `dd`, so that the second line has the same indentation as all
subsequent lines.

* Add commas between note list terms

https://github.com/ruby/rdoc/commit/9e69ea6d75
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
(https://github.com/ruby/rdoc/pull/1209)

* Use the original `label` description list style

As a default for all description lists, the original "label" style is
more readable.

This is slightly different from the original `label` dl though:
* slightly increased left margin for `dd` (to 1em)
* removed right margin on `dd`
* removed `dt` bottom margin and `dd` top margin, to reduce the gap
  between the term and its description (to only the standard line-height
  gap).

* Add closing tags for description list terms

Without the closing tags, the dt elements contain whitespace after the
text.  This normally isn't a big deal, but does mess some things up,
e.g: using `::after` with `content: ", "` in stylesheets.

* Restore float:left style for note lists

Unlike the original note list styles, this version sets the line-height
for all `dt` elements to be the same as the `p` elements contained
inside the `dd`, so that the second line has the same indentation as all
subsequent lines.

* Add commas between note list terms

https://github.com/ruby/rdoc/commit/9e69ea6d75
</pre>
</div>
</content>
</entry>
<entry>
<title>[ruby/rdoc] Deprecate `main` and `title` directives</title>
<updated>2024-12-05T11:36:34+00:00</updated>
<author>
<name>Stan Lo</name>
<email>stan001212@gmail.com</email>
</author>
<published>2024-12-05T11:36:28+00:00</published>
<link rel='alternate' type='text/html' href='https://git.ruby-lang.org/ruby.git/commit/?id=2ecd2fe0ed251f9946d5322d96cbfaf61ccbdd65'/>
<id>2ecd2fe0ed251f9946d5322d96cbfaf61ccbdd65</id>
<content type='text'>
(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
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
(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
</pre>
</div>
</content>
</entry>
<entry>
<title>[ruby/rdoc] Fix ToRdoc#accept_table</title>
<updated>2024-10-03T12:27:43+00:00</updated>
<author>
<name>tomoya ishida</name>
<email>tomoyapenguin@gmail.com</email>
</author>
<published>2024-10-03T12:27:39+00:00</published>
<link rel='alternate' type='text/html' href='https://git.ruby-lang.org/ruby.git/commit/?id=218445bb1fbda6b215b42e6149da672d330a7042'/>
<id>218445bb1fbda6b215b42e6149da672d330a7042</id>
<content type='text'>
(https://github.com/ruby/rdoc/pull/1184)

https://github.com/ruby/rdoc/commit/7b68545094
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
(https://github.com/ruby/rdoc/pull/1184)

https://github.com/ruby/rdoc/commit/7b68545094
</pre>
</div>
</content>
</entry>
<entry>
<title>[ruby/rdoc] Add new ruby parser that uses Prism</title>
<updated>2024-07-31T20:50:00+00:00</updated>
<author>
<name>tomoya ishida</name>
<email>tomoyapenguin@gmail.com</email>
</author>
<published>2024-07-31T20:49:56+00:00</published>
<link rel='alternate' type='text/html' href='https://git.ruby-lang.org/ruby.git/commit/?id=16b0242808b5a2dc7c1c80dc9ace547f64280a1b'/>
<id>16b0242808b5a2dc7c1c80dc9ace547f64280a1b</id>
<content type='text'>
(https://github.com/ruby/rdoc/pull/1144)

* Add a new ruby parser RDoc::Parser::PrismRuby

* Add a new ruby parser testcase independent from parser's internal implementation

* unknown meta method

* Use MethodSignatureVisitor only to scan params, block_params and calls_super

* Add calls_super test

* Drop ruby 2.6. Prism requires ruby &gt;= 2.7

* Remove duplicated documentation comment from prism_ruby.rb

* Add test for wrong argument passed to metaprogramming method

* Rename visit_call_[DSL_METHOD_NAME] to make it distinguishable from visit_[NODE_TYPE]_node

* Method receiver switch of true/false/nil to a case statement

* Extract common part of add_method(by def keyword) and add meta_comment method

* Reuse consecutive comments array when collecting comments

* Simplify DSL call_node handling

* Refactor extracting method visibility arguments

https://github.com/ruby/rdoc/commit/fde99f1be6
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
(https://github.com/ruby/rdoc/pull/1144)

* Add a new ruby parser RDoc::Parser::PrismRuby

* Add a new ruby parser testcase independent from parser's internal implementation

* unknown meta method

* Use MethodSignatureVisitor only to scan params, block_params and calls_super

* Add calls_super test

* Drop ruby 2.6. Prism requires ruby &gt;= 2.7

* Remove duplicated documentation comment from prism_ruby.rb

* Add test for wrong argument passed to metaprogramming method

* Rename visit_call_[DSL_METHOD_NAME] to make it distinguishable from visit_[NODE_TYPE]_node

* Method receiver switch of true/false/nil to a case statement

* Extract common part of add_method(by def keyword) and add meta_comment method

* Reuse consecutive comments array when collecting comments

* Simplify DSL call_node handling

* Refactor extracting method visibility arguments

https://github.com/ruby/rdoc/commit/fde99f1be6
</pre>
</div>
</content>
</entry>
<entry>
<title>[ruby/rdoc] Improve rubocop setup</title>
<updated>2024-07-17T20:43:08+00:00</updated>
<author>
<name>Stan Lo</name>
<email>stan001212@gmail.com</email>
</author>
<published>2024-07-17T20:42:58+00:00</published>
<link rel='alternate' type='text/html' href='https://git.ruby-lang.org/ruby.git/commit/?id=239d54dfbce0f38cf4d31fa252b4d9bd65477bac'/>
<id>239d54dfbce0f38cf4d31fa252b4d9bd65477bac</id>
<content type='text'>
(https://github.com/ruby/rdoc/pull/1139)

* Rename rake rubocop to rake format_generated_files

* Add rubocop rules to ensure spaces are applied consistently

* Improve rubocop related CI workflows

https://github.com/ruby/rdoc/commit/27932d001c
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
(https://github.com/ruby/rdoc/pull/1139)

* Rename rake rubocop to rake format_generated_files

* Add rubocop rules to ensure spaces are applied consistently

* Improve rubocop related CI workflows

https://github.com/ruby/rdoc/commit/27932d001c
</pre>
</div>
</content>
</entry>
<entry>
<title>[ruby/rdoc] Fix ToRdoc generating incorrect {label,name}-lists</title>
<updated>2024-03-09T03:50:09+00:00</updated>
<author>
<name>Hartley McGuire</name>
<email>skipkayhil@gmail.com</email>
</author>
<published>2024-03-06T01:13:38+00:00</published>
<link rel='alternate' type='text/html' href='https://git.ruby-lang.org/ruby.git/commit/?id=5ac6194c2b13856edd7e7bcaaa69a15519fd993e'/>
<id>5ac6194c2b13856edd7e7bcaaa69a15519fd993e</id>
<content type='text'>
Previously, trying to round-trip label-list and name-lists with the
ToRdoc converter was not possible:

```ruby
doc = &lt;&lt;~RDOC
foo ::
bar ::
  hi
RDOC

markup = RDoc::Markup.parse(doc)
markup # =&gt; [doc: [list: NOTE [item: ["foo ", "bar"]; [para: "hi"]]]]

rt = RDoc::Markup::ToRdoc.new.convert(markup)
rt # =&gt; "foo\nbar:\n  hi\n\n"

rt_markup = RDoc::Markup.parse(rt)
rt_markup # =&gt; [doc: [para: "foo ", "bar:"], [verb: "hi\n"]]
```

This commit addresses the issue by fixing ToRdoc to generate output that
can be properly reparsed by RDoc. ToRdoc tests additionally needed to be
updated for the new output.

The old implementation of `accept_list_item_start` was copied to ToBs
because those tests did not pass with the new changes and I am
unfamiliar with the `backspace` format.

After:

```ruby
doc = &lt;&lt;~RDOC
foo ::
bar ::
  hi
RDOC

markup = RDoc::Markup.parse(doc)
markup # =&gt; [doc: [list: NOTE [item: ["foo ", "bar"]; [para: "hi"]]]]

rt = RDoc::Markup::ToRdoc.new.convert(markup)
rt # =&gt; "foo::\nbar::\n  hi\n\n"

rt_markup = RDoc::Markup.parse(rt)
rt_markup # =&gt; [doc: [list: NOTE [item: ["foo", "bar"]; [para: "hi"], blankline]]]
```

https://github.com/ruby/rdoc/commit/c6c51aa900
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
Previously, trying to round-trip label-list and name-lists with the
ToRdoc converter was not possible:

```ruby
doc = &lt;&lt;~RDOC
foo ::
bar ::
  hi
RDOC

markup = RDoc::Markup.parse(doc)
markup # =&gt; [doc: [list: NOTE [item: ["foo ", "bar"]; [para: "hi"]]]]

rt = RDoc::Markup::ToRdoc.new.convert(markup)
rt # =&gt; "foo\nbar:\n  hi\n\n"

rt_markup = RDoc::Markup.parse(rt)
rt_markup # =&gt; [doc: [para: "foo ", "bar:"], [verb: "hi\n"]]
```

This commit addresses the issue by fixing ToRdoc to generate output that
can be properly reparsed by RDoc. ToRdoc tests additionally needed to be
updated for the new output.

The old implementation of `accept_list_item_start` was copied to ToBs
because those tests did not pass with the new changes and I am
unfamiliar with the `backspace` format.

After:

```ruby
doc = &lt;&lt;~RDOC
foo ::
bar ::
  hi
RDOC

markup = RDoc::Markup.parse(doc)
markup # =&gt; [doc: [list: NOTE [item: ["foo ", "bar"]; [para: "hi"]]]]

rt = RDoc::Markup::ToRdoc.new.convert(markup)
rt # =&gt; "foo::\nbar::\n  hi\n\n"

rt_markup = RDoc::Markup.parse(rt)
rt_markup # =&gt; [doc: [list: NOTE [item: ["foo", "bar"]; [para: "hi"], blankline]]]
```

https://github.com/ruby/rdoc/commit/c6c51aa900
</pre>
</div>
</content>
</entry>
</feed>
