Rails core - Dec 2007 - Documentation for Debugger, deprecate breakpoint?

In the index page of Rails doc, we have the Debugging Rails and
Breakpoints sections. I''m thinking maybe we should document ruby-debug
there. I would gladly make a doc patch and submit it but I thought I
should raise it here first.

Also, I haven''t really used the breakpoint command and script/
breakpointer client. Should we remove them from the index page? Should
we deprecate the breakpoint command (it''s implementation just calls
debugger)?
--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to the Google Groups
"Ruby on Rails: Core" group.
To post to this group, send email to rubyonrails-core@googlegroups.com
To unsubscribe from this group, send email to
rubyonrails-core-unsubscribe@googlegroups.com
For more options, visit this group at
http://groups.google.com/group/rubyonrails-core?hl=en
-~----------~----~----~----~------~----~------~--~---

On 27 Dec 2007, at 08:13, mikong wrote:
>
> In the index page of Rails doc, we have the Debugging Rails and
> Breakpoints sections. I''m thinking maybe we should document
ruby-debug
> there. I would gladly make a doc patch and submit it but I thought I
> should raise it here first.
>
> Also, I haven''t really used the breakpoint command and script/
> breakpointer client. Should we remove them from the index page? Should
> we deprecate the breakpoint command (it''s implementation just
calls
> debugger)?
Calling breakpoint outputs "***** The ''breakpoint''
command has been
renamed ''debugger'' -- please change *****". Is more
really needed ?

Fred

--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to the Google Groups
"Ruby on Rails: Core" group.
To post to this group, send email to rubyonrails-core@googlegroups.com
To unsubscribe from this group, send email to
rubyonrails-core-unsubscribe@googlegroups.com
For more options, visit this group at
http://groups.google.com/group/rubyonrails-core?hl=en
-~----------~----~----~----~------~----~------~--~---

On Dec 27, 5:53 pm, Frederick Cheung <frederick.che...@gmail.com>
wrote:
> On 27 Dec 2007, at 08:13, mikong wrote:
>
>
>
> > In the index page of Rails doc, we have the Debugging Rails and
> > Breakpoints sections. I''m thinking maybe we should document
ruby-debug
> > there. I would gladly make a doc patch and submit it but I thought I
> > should raise it here first.
>
> > Also, I haven''t really used the breakpoint command and
script/
> > breakpointer client. Should we remove them from the index page? Should
> > we deprecate the breakpoint command (it''s implementation just
calls
> > debugger)?
>
> Calling breakpoint outputs "***** The ''breakpoint''
command has been
> renamed ''debugger'' -- please change *****". Is more
really needed ?
>
> Fred
I don''t know the exact procedure for deprecating methods. I thought it
should have a deprecated keyword in the comments. Maybe there''s a
script that scans for this or something. Maybe that''s why it
hasn''t
been removed in 2.0?
--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to the Google Groups
"Ruby on Rails: Core" group.
To post to this group, send email to rubyonrails-core@googlegroups.com
To unsubscribe from this group, send email to
rubyonrails-core-unsubscribe@googlegroups.com
For more options, visit this group at
http://groups.google.com/group/rubyonrails-core?hl=en
-~----------~----~----~----~------~----~------~--~---

The typical form, I think, is something like:

    DEPRECATION WARNING:  The +breakpoint+ command has been renamed to
+debugger+.

--Jeremy

On Dec 27, 2007 5:01 AM, mikong <michaelgalero@gmail.com>
wrote:
>
> On Dec 27, 5:53 pm, Frederick Cheung <frederick.che...@gmail.com>
> wrote:
> > On 27 Dec 2007, at 08:13, mikong wrote:
> >
> >
> >
> > > In the index page of Rails doc, we have the Debugging Rails and
> > > Breakpoints sections. I''m thinking maybe we should
document ruby-debug
> > > there. I would gladly make a doc patch and submit it but I
thought I
> > > should raise it here first.
> >
> > > Also, I haven''t really used the breakpoint command and
script/
> > > breakpointer client. Should we remove them from the index page?
Should
> > > we deprecate the breakpoint command (it''s implementation
just calls
> > > debugger)?
> >
> > Calling breakpoint outputs "***** The
''breakpoint'' command has been
> > renamed ''debugger'' -- please change *****". Is
more really needed ?
> >
> > Fred
>
> I don''t know the exact procedure for deprecating methods. I
thought it
> should have a deprecated keyword in the comments. Maybe there''s a
> script that scans for this or something. Maybe that''s why it
hasn''t
> been removed in 2.0?
>
> >
>


-- 
http://www.jeremymcanally.com/

My books:
Ruby in Practice
http://www.manning.com/mcanally/

My free Ruby e-book
http://www.humblelittlerubybook.com/

My blogs:
http://www.mrneighborly.com/
http://www.rubyinpractice.com/

--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to the Google Groups
"Ruby on Rails: Core" group.
To post to this group, send email to rubyonrails-core@googlegroups.com
To unsubscribe from this group, send email to
rubyonrails-core-unsubscribe@googlegroups.com
For more options, visit this group at
http://groups.google.com/group/rubyonrails-core?hl=en
-~----------~----~----~----~------~----~------~--~---

I said,
> In the index page of Rails doc, we have the Debugging Rails and
> Breakpoints sections.
Sorry about this, the Breakpoints section has already been replaced by
the Debugger section in railties/README file. I thought running rake
doc:rails would update my doc/api/index.html to the new railties/
README. It looks like it''s still getting the copy from my contribute
project''s README which was generated before Rails 2.0 and so still
showed the Breakpoints section.
--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to the Google Groups
"Ruby on Rails: Core" group.
To post to this group, send email to rubyonrails-core@googlegroups.com
To unsubscribe from this group, send email to
rubyonrails-core-unsubscribe@googlegroups.com
For more options, visit this group at
http://groups.google.com/group/rubyonrails-core?hl=en
-~----------~----~----~----~------~----~------~--~---