Ruby on Rails | Screencasts | Download | Documentation | Weblog | Community | Source

Ticket #10637 (new enhancement)

Opened 5 months ago

Last modified 4 months ago

[PATCH] Doc update for Debugger section of the API README to mention ruby-debug gem

Reported by: mikong Assigned to: core
Priority: normal Milestone: 2.x
Component: Railties Version: edge
Severity: normal Keywords: doc unverified
Cc:

Description

The current documentation of debugger on the API README doesn't mention the ruby-debug gem which is required for the debugger to work. This patch adds this and also fixes a few minor things like being consistent with the document to refer to WEBrick with a capital EB, adding a missing period, and wrapping commands in <tt></tt> instead of quotes. I also removed those trailing / at the end of the links cause they end up outside the link tags when the HTML is generated.

Attachments

doc_update_for_debugger_section_to_mention_ruby_debug_gem.diff (2.9 kB) - added by mikong on 12/28/07 15:58:46.
reworded_and_include_ruby_debug_homepage.diff (3.6 kB) - added by jamesh on 12/28/07 16:51:54.
reworded_and_include_ruby_debug_homepage.2.diff (3.6 kB) - added by jamesh on 12/28/07 18:31:28.
remove_example_cleanup_dirs_too.diff (7.1 kB) - added by jamesh on 01/03/08 07:16:47.
Removed example debugger usage, opting for blog URL instead. Cleaned up some other cruft at the bottom of the README

Change History

12/28/07 15:58:46 changed by mikong

  • attachment doc_update_for_debugger_section_to_mention_ruby_debug_gem.diff added.

12/28/07 16:48:25 changed by jamesh

I've tried to apply your patch and succeeded, and also reworded things a little bit. I've also included a link back to the Ruby-Debug project page.

Something is kind of bugging me though about the section on debugging. I'm fairly certain that the example is incorrect. I'm only fairly certain because I never use debugger as outlined in the docs: I tend to use it in a more free-form manner. When using debugger as I do, you aren't put immediately into an IRB-like console as the docs suggest. Is this different for how Rails uses Ruby-Debug with script/server or webrick?

12/28/07 16:51:54 changed by jamesh

  • attachment reworded_and_include_ruby_debug_homepage.diff added.

(follow-up: ↓ 3 ) 12/28/07 17:12:34 changed by mikong

I was having second thoughts with including the link to the ruby-debug project page because I had a recent discussion Rocky Bernstein and he mentioned that he's still looking for a place to host the official ruby-debug documentation. But I don't mind that you added it. It can be updated anyway when the new project page becomes available.

Btw, I don't think ruby-debug should be referred to as title-case Ruby-Debug because even the Reference Guide of ruby-debug refers to it with lowercase (see the ruby-debug-extra-0.10.0.tar.gz). Their Data Noise blog (click the Project Home Page link of ruby-debug in RubyForge), though the blog is a bit outdated, also refers to it with lowercase.

(in reply to: ↑ 2 ) 12/28/07 18:30:41 changed by jamesh

Replying to mikong:

I was having second thoughts with including the link to the ruby-debug project page because I had a recent discussion Rocky Bernstein and he mentioned that he's still looking for a place to host the official ruby-debug documentation. But I don't mind that you added it. It can be updated anyway when the new project page becomes available.

Understandable. I looked around for their docs online and couldn't find them. I guess I know why now :)

Btw, I don't think ruby-debug should be referred to as title-case Ruby-Debug because even the Reference Guide of ruby-debug refers to it with lowercase (see the ruby-debug-extra-0.10.0.tar.gz). Their Data Noise blog (click the Project Home Page link of ruby-debug in RubyForge), though the blog is a bit outdated, also refers to it with lowercase.

Agreed. I've updated the patch to use lowercase.

Can you verify the behaviour of ruby-debug in Rails per the style described in the documentation's example?

12/28/07 18:31:28 changed by jamesh

  • attachment reworded_and_include_ruby_debug_homepage.2.diff added.

(follow-up: ↓ 5 ) 12/30/07 08:48:09 changed by mikong

The example is indeed incorrect. You are initially given a ruby-debug prompt. Only if you run the irb command in this prompt will you be given an irb prompt.

(in reply to: ↑ 4 ) 01/03/08 07:15:56 changed by jamesh

Replying to mikong:

The example is indeed incorrect. You are initially given a ruby-debug prompt. Only if you run the irb command in this prompt will you be given an irb prompt.

Okay, how this latest patch? I've yanked the example entirely and have opted to point to the ruby-debug blog. This way information is always current.

(I've also cleaned up some crap at the bottom of the README too)

01/03/08 07:16:47 changed by jamesh

  • attachment remove_example_cleanup_dirs_too.diff added.

Removed example debugger usage, opting for blog URL instead. Cleaned up some other cruft at the bottom of the README