summaryrefslogtreecommitdiff
path: root/lib/rdoc/comment.rb
diff options
context:
space:
mode:
authorJeremy Evans <[email protected]>2023-02-19 14:46:13 -0800
committergit <[email protected]>2023-09-05 00:45:42 +0000
commit3f6c92e9d592a2b122fb2260fccee7a7dd850cb8 (patch)
tree424e44f808f86e80a4db7741fabb288281259897 /lib/rdoc/comment.rb
parenta14ba622da01c7774d0fb285b183097d19e3675e (diff)
[ruby/rdoc] Omit descriptions and parameter lists for methods defined in C not mentioned in call-seq
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
Diffstat (limited to 'lib/rdoc/comment.rb')
0 files changed, 0 insertions, 0 deletions