<feed xmlns='http://www.w3.org/2005/Atom'>
<title>ruby.git/lib/rdoc/generator, branch v3_3_11</title>
<subtitle>The Ruby Programming Language</subtitle>
<link rel='alternate' type='text/html' href='https://git.ruby-lang.org/ruby.git/'/>
<entry>
<title>[ruby/rdoc] [DOC] nodoc for probably internal methods</title>
<updated>2023-12-15T15:26:39+00:00</updated>
<author>
<name>Nobuyoshi Nakada</name>
<email>nobu@ruby-lang.org</email>
</author>
<published>2023-12-15T10:36:07+00:00</published>
<link rel='alternate' type='text/html' href='https://git.ruby-lang.org/ruby.git/commit/?id=20f4f007644b841c71402a5ae64ee5373dc7b91a'/>
<id>20f4f007644b841c71402a5ae64ee5373dc7b91a</id>
<content type='text'>
https://github.com/ruby/rdoc/commit/f7dd147a8c
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
https://github.com/ruby/rdoc/commit/f7dd147a8c
</pre>
</div>
</content>
</entry>
<entry>
<title>[ruby/rdoc] [DOC] Slightly decorate `em` and `strong`</title>
<updated>2023-11-27T16:07:03+00:00</updated>
<author>
<name>Nobuyoshi Nakada</name>
<email>nobu@ruby-lang.org</email>
</author>
<published>2023-11-27T16:06:47+00:00</published>
<link rel='alternate' type='text/html' href='https://git.ruby-lang.org/ruby.git/commit/?id=7973eb7c3f6531a41adb9de63d1b3c4d5d4b7d03'/>
<id>7973eb7c3f6531a41adb9de63d1b3c4d5d4b7d03</id>
<content type='text'>
https://github.com/ruby/rdoc/commit/2161157205
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
https://github.com/ruby/rdoc/commit/2161157205
</pre>
</div>
</content>
</entry>
<entry>
<title>[ruby/rdoc] Remove code for versions older than Ruby 2.6</title>
<updated>2023-09-05T01:14:52+00:00</updated>
<author>
<name>Nobuyoshi Nakada</name>
<email>nobu@ruby-lang.org</email>
</author>
<published>2023-09-05T00:49:27+00:00</published>
<link rel='alternate' type='text/html' href='https://git.ruby-lang.org/ruby.git/commit/?id=dab6d55db115448680968da1f46194886e5eac84'/>
<id>dab6d55db115448680968da1f46194886e5eac84</id>
<content type='text'>
https://github.com/ruby/rdoc/commit/0d10f460eb
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
https://github.com/ruby/rdoc/commit/0d10f460eb
</pre>
</div>
</content>
</entry>
<entry>
<title>[ruby/rdoc] Omit descriptions and parameter lists for methods defined in C not mentioned in call-seq</title>
<updated>2023-09-05T00:45:42+00:00</updated>
<author>
<name>Jeremy Evans</name>
<email>code@jeremyevans.net</email>
</author>
<published>2023-02-19T22:46:13+00:00</published>
<link rel='alternate' type='text/html' href='https://git.ruby-lang.org/ruby.git/commit/?id=3f6c92e9d592a2b122fb2260fccee7a7dd850cb8'/>
<id>3f6c92e9d592a2b122fb2260fccee7a7dd850cb8</id>
<content type='text'>
This allows RDoc to better generate documentation for methods
following the Ruby core documentation guide (which omits aliases
in call-seq in most cases).  This makes documentation for methods
defined in C more similar to methods defined in Ruby.  For methods
defined in Ruby, the method description of the aliased method is
already not used (you have to explicitly document the alias to
use it).

Internally, this adds AnyMethod#has_call_seq? and #skip_description?,
and updates Darkfish to:

* only show the method name if there is a call-seq for the method,
  but the call-seq omits the method
* to omit the method description if the method is an alias or has
  aliases and has a call-seq that does not include the method

See discussion in https://github.com/ruby/ruby/pull/7316 for
details.

https://github.com/ruby/rdoc/commit/e3688de49b
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
This allows RDoc to better generate documentation for methods
following the Ruby core documentation guide (which omits aliases
in call-seq in most cases).  This makes documentation for methods
defined in C more similar to methods defined in Ruby.  For methods
defined in Ruby, the method description of the aliased method is
already not used (you have to explicitly document the alias to
use it).

Internally, this adds AnyMethod#has_call_seq? and #skip_description?,
and updates Darkfish to:

* only show the method name if there is a call-seq for the method,
  but the call-seq omits the method
* to omit the method description if the method is an alias or has
  aliases and has a call-seq that does not include the method

See discussion in https://github.com/ruby/ruby/pull/7316 for
details.

https://github.com/ruby/rdoc/commit/e3688de49b
</pre>
</div>
</content>
</entry>
<entry>
<title>[ruby/rdoc] [DOC] Improve CSS for "toggle source" hovering over one more method signatures</title>
<updated>2023-07-05T04:09:08+00:00</updated>
<author>
<name>Masafumi Koba</name>
<email>473530+ybiquitous@users.noreply.github.com</email>
</author>
<published>2023-07-05T04:09:04+00:00</published>
<link rel='alternate' type='text/html' href='https://git.ruby-lang.org/ruby.git/commit/?id=62b4983416022d3b286b5b1f9fbd908e9a0cfb6d'/>
<id>62b4983416022d3b286b5b1f9fbd908e9a0cfb6d</id>
<content type='text'>
This commit improves the behavior of showing the "toggle source" element on mouseover.

For example, when a method has one more signatures by using `:call-seq:`,

```ruby
# :call-seq:
#   foo {|element| ... } -&gt; self
#   foo -&gt; new_enumeration
def foo
end
```

The current CSS doesn't show "toggle source" even when hovering the second signature `foo -&gt; new_enumeration`.
But this change will show "toggle source" always when hovering over any signature.

For details about the `.method-header` element, see `lib/rdoc/generator/template/darkfish/class.rhtml`:
https://github.com/ruby/rdoc/blob/0e060c69f51ec4a877e5cde69b31d47eaeb2a2b9/lib/rdoc/generator/template/darkfish/class.rhtml#L101-L124

For example, see https://docs.ruby-lang.org/en/3.2/Array.html#method-i-delete
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
This commit improves the behavior of showing the "toggle source" element on mouseover.

For example, when a method has one more signatures by using `:call-seq:`,

```ruby
# :call-seq:
#   foo {|element| ... } -&gt; self
#   foo -&gt; new_enumeration
def foo
end
```

The current CSS doesn't show "toggle source" even when hovering the second signature `foo -&gt; new_enumeration`.
But this change will show "toggle source" always when hovering over any signature.

For details about the `.method-header` element, see `lib/rdoc/generator/template/darkfish/class.rhtml`:
https://github.com/ruby/rdoc/blob/0e060c69f51ec4a877e5cde69b31d47eaeb2a2b9/lib/rdoc/generator/template/darkfish/class.rhtml#L101-L124

For example, see https://docs.ruby-lang.org/en/3.2/Array.html#method-i-delete
</pre>
</div>
</content>
</entry>
<entry>
<title>[ruby/rdoc] [DOC] Fix to use KeyboardEvent.key over keyCode</title>
<updated>2023-07-05T03:39:18+00:00</updated>
<author>
<name>gemmaro</name>
<email>gemmaro.dev@gmail.com</email>
</author>
<published>2023-07-05T03:39:14+00:00</published>
<link rel='alternate' type='text/html' href='https://git.ruby-lang.org/ruby.git/commit/?id=62754503d8ba0307e9f8581a5d1bf5b76f6437ae'/>
<id>62754503d8ba0307e9f8581a5d1bf5b76f6437ae</id>
<content type='text'>
https://github.com/ruby/rdoc/commit/663edc807c
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
https://github.com/ruby/rdoc/commit/663edc807c
</pre>
</div>
</content>
</entry>
<entry>
<title>[ruby/rdoc] Add keydown event listener to focus on search field</title>
<updated>2023-07-05T03:37:28+00:00</updated>
<author>
<name>gemmaro</name>
<email>gemmaro.dev@gmail.com</email>
</author>
<published>2022-09-24T14:29:51+00:00</published>
<link rel='alternate' type='text/html' href='https://git.ruby-lang.org/ruby.git/commit/?id=77fa4787bd26b5193a5cc72226c1a3469f91ba11'/>
<id>77fa4787bd26b5193a5cc72226c1a3469f91ba11</id>
<content type='text'>
https://github.com/ruby/rdoc/commit/db62e47df2
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
https://github.com/ruby/rdoc/commit/db62e47df2
</pre>
</div>
</content>
</entry>
<entry>
<title>[ruby/rdoc] Use flat_map for better performance</title>
<updated>2023-06-14T23:47:25+00:00</updated>
<author>
<name>Petrik</name>
<email>petrik@deheus.net</email>
</author>
<published>2023-06-14T20:39:47+00:00</published>
<link rel='alternate' type='text/html' href='https://git.ruby-lang.org/ruby.git/commit/?id=0c55ef11509d0cf480ef46b98965a63f6499c6bd'/>
<id>0c55ef11509d0cf480ef46b98965a63f6499c6bd</id>
<content type='text'>
https://github.com/ruby/rdoc/commit/76192a280d
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
https://github.com/ruby/rdoc/commit/76192a280d
</pre>
</div>
</content>
</entry>
<entry>
<title>[ruby/rdoc] Auto-correct trailing new lines</title>
<updated>2023-06-03T01:42:29+00:00</updated>
<author>
<name>Vinicius Stock</name>
<email>stock@hey.com</email>
</author>
<published>2023-06-02T22:56:15+00:00</published>
<link rel='alternate' type='text/html' href='https://git.ruby-lang.org/ruby.git/commit/?id=a4d92475f69f0ca3dba0f497253e600c7f90a0ad'/>
<id>a4d92475f69f0ca3dba0f497253e600c7f90a0ad</id>
<content type='text'>
https://github.com/ruby/rdoc/commit/4b68c0728a
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
https://github.com/ruby/rdoc/commit/4b68c0728a
</pre>
</div>
</content>
</entry>
<entry>
<title>[ruby/rdoc] Improve `&lt;summary&gt;` CSS on sidebar</title>
<updated>2023-05-26T16:26:46+00:00</updated>
<author>
<name>Masafumi Koba</name>
<email>473530+ybiquitous@users.noreply.github.com</email>
</author>
<published>2023-05-26T13:52:12+00:00</published>
<link rel='alternate' type='text/html' href='https://git.ruby-lang.org/ruby.git/commit/?id=94e5ecbbdd9ea1610dd8aaa55a6f9aa3ddb15ab1'/>
<id>94e5ecbbdd9ea1610dd8aaa55a6f9aa3ddb15ab1</id>
<content type='text'>
- Use a smaller font size for the toggle symbol. (Currently, it seems a little too large)
- Use the child combinator (`&gt;`) to unify selectors.
- Use `margin-left` instead of whitespace within the `content` property.
- Use `::` instead of outdated `:` for the pseudo-element symbol.
  (See https://developer.mozilla.org/en-US/docs/Web/CSS/::before)

https://github.com/ruby/rdoc/commit/61ce0a7d75
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
- Use a smaller font size for the toggle symbol. (Currently, it seems a little too large)
- Use the child combinator (`&gt;`) to unify selectors.
- Use `margin-left` instead of whitespace within the `content` property.
- Use `::` instead of outdated `:` for the pseudo-element symbol.
  (See https://developer.mozilla.org/en-US/docs/Web/CSS/::before)

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