mirror of
https://github.com/ruby/ruby.git
synced 2025-08-24 13:34:17 +02:00
3f6c92e9d5
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.
|
||
|---|---|---|
| .. | ||
| css | ||
| fonts | ||
| images | ||
| js | ||
| .document | ||
| _footer.rhtml | ||
| _head.rhtml | ||
| _sidebar_classes.rhtml | ||
| _sidebar_extends.rhtml | ||
| _sidebar_in_files.rhtml | ||
| _sidebar_includes.rhtml | ||
| _sidebar_installed.rhtml | ||
| _sidebar_methods.rhtml | ||
| _sidebar_navigation.rhtml | ||
| _sidebar_pages.rhtml | ||
| _sidebar_parent.rhtml | ||
| _sidebar_search.rhtml | ||
| _sidebar_sections.rhtml | ||
| _sidebar_table_of_contents.rhtml | ||
| _sidebar_VCS_info.rhtml | ||
| class.rhtml | ||
| index.rhtml | ||
| page.rhtml | ||
| servlet_not_found.rhtml | ||
| servlet_root.rhtml | ||
| table_of_contents.rhtml | ||