Bug #13273: [DOC] Proc#call docs show "Document-method: []" directive

• Status: Closed
• Assignee: stomar (Marcus Stollsteimer)
• Target version: -
• ruby -v: ruby 2.4.0p0 (2016-12-24 revision 57164) [x86_64-linux]
• Backport: 2.2: DONE, 2.3: DONE, 2.4: DONE

[stomar (Marcus Stollsteimer)]

The documentation for Proc#call displays one of its Document-method directives as a code block:

$ ri Proc.call

------------------------------------------------------------------------------
  prc.call(params,...)   -> obj
------------------------------------------------------------------------------

  Document-method: []

Invokes the block, ...

See also https://docs.ruby-lang.org/en/2.3.0/Proc.html#method-i-call.

[stomar (Marcus Stollsteimer)]

• Status changed from Open to Closed

Applied in changeset r57765.

---

proc.c: documentation for Proc#{call,yield,[]}

• proc.c: [DOC] fix and improve docs for Proc#{call,yield,[]}:

  • change order of Document-method directives as workaround for an
    RDoc rendering problem where the documentation for Proc#call displays
    a "Document-method: []" code block. [ruby-core:79887] [Bug #13273]
  • add missing call-seq and example for Proc#yield
  • remove pointless cross reference to Proc#yield
  • update description for handling of extra or missing arguments,
    improve examples and add cross reference to #lambda?

[stomar (Marcus Stollsteimer)]

• Related to Bug #13275: RDoc bug for "Document-method: []" added

[naruse (Yui NARUSE)]

• Backport changed from 2.2: UNKNOWN, 2.3: UNKNOWN, 2.4: UNKNOWN to 2.2: UNKNOWN, 2.3: UNKNOWN, 2.4: DONE

ruby_2_4 r57923 merged revision(s) 57765.

[nagachika (Tomoyuki Chikanaga)]

• Backport changed from 2.2: UNKNOWN, 2.3: UNKNOWN, 2.4: DONE to 2.2: REQUIRED, 2.3: REQUIRED, 2.4: DONE

[usa (Usaku NAKAMURA)]

• Backport changed from 2.2: REQUIRED, 2.3: REQUIRED, 2.4: DONE to 2.2: DONE, 2.3: REQUIRED, 2.4: DONE

ruby_2_2 r58105 merged revision(s) 57765.

[nagachika (Tomoyuki Chikanaga)]

• Backport changed from 2.2: DONE, 2.3: REQUIRED, 2.4: DONE to 2.2: DONE, 2.3: DONE, 2.4: DONE

ruby_2_3 r58185 merged revision(s) 57765.