Bug #6007: Use directive hack to make ARGF documentable in other tools

• Status: Closed
• Assignee: -
• Target version: -
• ruby -v: 2.0.0 (trunk)

[lsegal (Loren Segal)]

RDoc is able to parse commented blocks of code (inside /**/) as a side-effect of its parsing, but other tools will ignore commented blocks. Using the "#if 0" directive hack is more portable among tools (like YARD) and still allows developers to properly ignore code by commenting it out (assuming the doc tool supports this). Note that the directive hack is already used in io.c (above this line), so this is not a novel methodology.

Note that I opened a pull request on Github also, just in case: https://github.com/ruby/ruby/pull/93

If this is accepted, can it be backported into 1.9.3 as well?

[lsegal (Loren Segal)]

• File improve-ARGF-detection.patch improve-ARGF-detection.patch added

(Adding patch)

[nobu (Nobuyoshi Nakada)]

• Status changed from Open to Closed
• % Done changed from 0 to 100

This issue was solved with changeset r34576.
Loren, thank you for reporting this issue.
Your contribution to Ruby is greatly appreciated.
May Ruby be with you.

---

• io.c (Init_IO): use directive hack to make ARGF documentable
  in other tools. [ruby-core:42515][Bug #6007]