Bug #6743

Add documentation for debug library

Added by Oscar Del Ben over 2 years ago. Updated over 2 years ago.

[ruby-core:46520]
Status:Closed
Priority:Normal
Assignee:Eric Hodel
ruby -v:2.0.0dev Backport:

Description

Added initial documentation for the library.

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

0001-Add-documentation-for-Debug-library.patch Magnifier (15 KB) Oscar Del Ben, 07/17/2012 02:51 AM

Associated revisions

Revision 36426
Added by Eric Hodel over 2 years ago

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

Revision 36426
Added by Eric Hodel over 2 years ago

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

History

#2 Updated by Eric Hodel over 2 years ago

  • 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.

#3 Updated by Eric Hodel over 2 years ago

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.

#4 Updated by Oscar Del Ben over 2 years ago

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?

#5 Updated by Eric Hodel over 2 years ago

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.

Also available in: Atom PDF