https://redmine.ruby-lang.org/https://redmine.ruby-lang.org/favicon.ico?17113305112012-07-17T02:52:12ZRuby Issue Tracking SystemRuby master - Bug #6743: Add documentation for debug libraryhttps://redmine.ruby-lang.org/issues/6743?journal_id=281592012-07-17T02:52:12Zoscardelben (Oscar Del Ben)oscar@oscardelben.com
<ul></ul><p><a href="https://github.com/ruby/ruby/pull/146" class="external">https://github.com/ruby/ruby/pull/146</a></p> Ruby master - Bug #6743: Add documentation for debug libraryhttps://redmine.ruby-lang.org/issues/6743?journal_id=281832012-07-18T10:02:15Zdrbrain (Eric Hodel)drbrain@segment7.net
<ul><li><strong>Status</strong> changed from <i>Open</i> to <i>Closed</i></li><li><strong>% Done</strong> changed from <i>0</i> to <i>100</i></li></ul><p>This issue was solved with changeset r36426.<br>
Oscar, thank you for reporting this issue.<br>
Your contribution to Ruby is greatly appreciated.<br>
May Ruby be with you.</p>
<hr>
<ul>
<li>lib/debug.rb: Added toplevel documentation. Based on patch by Oscar<br>
Del Ben. [Bug <a class="issue tracker-1 status-5 priority-4 priority-default closed" title="Bug: Add documentation for debug library (Closed)" href="https://redmine.ruby-lang.org/issues/6743">#6743</a>], fixes <a class="issue tracker-4 status-5 priority-4 priority-default closed" title="Backport: Incorrect line numbers in "caller" output when evaluated in a Proc binding (Closed)" href="https://redmine.ruby-lang.org/issues/146">#146</a> on github.</li>
</ul> Ruby master - Bug #6743: Add documentation for debug libraryhttps://redmine.ruby-lang.org/issues/6743?journal_id=281842012-07-18T10:02:53Zdrbrain (Eric Hodel)drbrain@segment7.net
<ul></ul><p>I like the documentation, but I can't apply the rename from Debugger to DEBUGGER__.</p>
<p>The nodoc additions seem excessive and random too, so I omitted them.</p> Ruby master - Bug #6743: Add documentation for debug libraryhttps://redmine.ruby-lang.org/issues/6743?journal_id=281852012-07-18T10:43:13Zoscardelben (Oscar Del Ben)oscar@oscardelben.com
<ul></ul><p>Hi Eric,</p>
<p>Thank you for taking the time to review this. I was actually trying to rename from DEBUGGER__ to Debugger, which made things nicer for Rdoc. This may just be me not understanding how to properly generate docs though.</p>
<p>P.S.: is it useful that I add a separate PR on Github, or is it just noise?</p> Ruby master - Bug #6743: Add documentation for debug libraryhttps://redmine.ruby-lang.org/issues/6743?journal_id=281862012-07-18T11:07:13Zdrbrain (Eric Hodel)drbrain@segment7.net
<ul></ul><p>I think matz would need to rule on the name change from DEBUGGER__ to Debugger, so please file it as a separate issue.</p>
<p>I was unsure on the nodocs since they weren't added to all the methods. While debug.rb seems to be only usable from a console, I have not investigated closely enough to see if methods such as suspend, resume and interrupt could be used as API alongside suspend_all, resume_all, etc.. Feel free to update this issue with further nodocs if you think they are all internals.</p>