From: Loren Segal Date: 2012-02-13T09:35:49+09:00 Subject: [ruby-core:42516] [ruby-trunk - Bug #6007] Use directive hack to make ARGF documentable in other tools Issue #6007 has been updated by Loren Segal. File improve-ARGF-detection.patch added (Adding patch) ---------------------------------------- Bug #6007: Use directive hack to make ARGF documentable in other tools https://bugs.ruby-lang.org/issues/6007 Author: Loren Segal Status: Open Priority: Normal Assignee: Category: DOC Target version: ruby -v: 2.0.0 (trunk) 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? -- http://bugs.ruby-lang.org/