Bug #6743: Add documentation for debug library

• Status: Closed
• Assignee: drbrain (Eric Hodel)
• Target version: 2.0.0
• ruby -v: 2.0.0dev

[oscardelben (Oscar Del Ben)]

Added initial documentation for the library.

I've refactored DEBUGGER__ to Debugger so that it can appear in the documentation listing.

[oscardelben (Oscar Del Ben)]

https://github.com/ruby/ruby/pull/146

[drbrain (Eric Hodel)]

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

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

---

• lib/debug.rb: Added toplevel documentation. Based on patch by Oscar
  Del Ben. [Bug #6743], fixes #146 on github.

[drbrain (Eric Hodel)]

I like the documentation, but I can't apply the rename from Debugger to DEBUGGER__.

The nodoc additions seem excessive and random too, so I omitted them.

[oscardelben (Oscar Del Ben)]

Hi Eric,

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.S.: is it useful that I add a separate PR on Github, or is it just noise?

[drbrain (Eric Hodel)]

I think matz would need to rule on the name change from DEBUGGER__ to Debugger, so please file it as a separate issue.

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.