bugGNU Octave - Bugs: bug #34662, Erroneous `debug_on_error' Flag...

 
 

bug #34662: Erroneous `debug_on_error' Flag in debug docstring

Submitter:  Clem <clemwang>
Submitted:  Wed 26 Oct 2011 09:40:30 PM UTC
   
 
Category:  None Severity:  3 - Normal
Priority:  5 - Normal Item Group:  Documentation
Status:  Fixed Assigned to:  jordigh
Originator Name:  Clem Open/Closed:  * Closed
Release:  * 3.4.3 Operating System:  * Mac OS
Fixed Release:  None Planned Release:  None
* Mandatory Fields

Add a New Comment Rich Markup
   

Tue 15 Nov 2011 02:54:32 AM UTC, comment #3: 

Fixed in this changeset:

http://hg.savannah.gnu.org/hgweb/octave/rev/922bfdd80413

Thanks for reporting. This will be part of the 3.6 release scheduled for next month.

Jordi GutiƩrrez Hermoso <jordigh>
Group Member
Thu 27 Oct 2011 01:51:38 AM UTC, comment #2: 

Confirmed. I'll work on fixing this part of the documentation. Thank you for spotting it.

Jordi GutiƩrrez Hermoso <jordigh>
Group Member
Wed 26 Oct 2011 09:48:53 PM UTC, comment #1: 

Dude, there is no need to shout.  You do realize that everyone working on Octave is a volunteer, just like you, right?

John W. Eaton <jwe>
Group administrator
Wed 26 Oct 2011 09:40:30 PM UTC, original submission:  

If you type:
help debug

you get this WRONG info:

    `debug_on_error'
          Flag whether to enter debug mode in case Octave encounters an
          error.

    `debug_on_warning'
          Flag whether to enter debug mode in case Octave encounters a
          warning.

    `debug_on_interrupt'
          Flag whether to enter debug mode in case Octave encounters an
          interupt.



These were flags but now are function that take a boolean argument to turn the debugging mode on or off.  If you actually try to set the flag you get an error msg:



>> debug_on_error = 1

warning: debug_on_error is now a function instead of a built-in variable.  By assigning to debug_on_error, you have created a variable that hides the function debug_on_error.  To remove the variable and restore the function, type "clear debug_on_error"
debug_on_error =  1



Also, this err msg is a bit confusing.  "debug_on_error is now a function" could be wrongly interpreted as "your action has just changed debug_on_error into a function" which is the opposite of what you're trying to inform the user!

Better would be "Since Octave Version X.X.X, debug_on_error has been changed from a built-in variable to a function."

Clem <clemwang>

 

(Note: upload size limit is set to 16384 kB, after insertion of the required escape characters.)

Attach Files:
   
   
Comment:
   

No files currently attached

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -email is unavailable- added by jordigh (Posted a comment)
  • -email is unavailable- added by jwe (Posted a comment)
  • -email is unavailable- added by clemwang (Submitted the item)
  • -email is unavailable- added by clemwang (debug_on_error)
  •  

    There are 0 votes so far. Votes easily highlight which items people would like to see resolved in priority, independently of the priority of the item set by tracker managers.

    Only group members can vote.

     

    Follow 7 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2011-11-15 jordigh StatusConfirmed Fixed
        Open/ClosedOpen Closed
    2011-10-27 jordigh StatusNone Confirmed
        Assigned toNone jordigh
        Release3.4.0 3.4.3
        SummaryWRONG: `debug_on_error\' Flag Erroneous `debug_on_error' Flag in debug docstring
    2011-10-26 clemwang Carbon-Copy- Added clemwang

    Back to the top

    Powered by Savane 3.13-caa5.
    Corresponding source code