Skip to content
  • Jeremy Evans's avatar
    3f6c92e9
    [ruby/rdoc] Omit descriptions and parameter lists for methods defined in C not... · 3f6c92e9
    Jeremy Evans authored
    [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
    3f6c92e9
    [ruby/rdoc] Omit descriptions and parameter lists for methods defined in C not...
    Jeremy Evans authored
    [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
Loading