bugGNU Octave - Bugs: bug #48974, Should doc-string of function...

 
 

bug #48974: Should doc-string of function "help" add "paren", besides "comma" and "semicolon"?

Submitter:  None
Submitted:  Fri 02 Sep 2016 03:58:48 AM UTC
   
 
Category:  Documentation Severity:  3 - Normal
Priority:  5 - Normal Item Group:  None
Status:  None Assigned to:  None
Originator Name:  Originator Email:  -email is unavailable-
Open/Closed:  * Closed Release:  * 4.0.3
Operating System:  * Any Fixed Release:  None
Planned Release:  None
* Mandatory Fields

Add a New Comment Rich Markup
   

Fri 02 Sep 2016 04:43:48 PM UTC, comment #1: 

The documentation for help has been changed for the upcoming 4.2 release to state that all operators should be enclosed in quotes to prevent their interpretation by Octave.  The script files comma.m, semicolon.m, and paren.m are now deprecated and will be removed in version 4.6.

The 4.2 release should get started next week with the first release candidate, an will probably finish up by the end of September.

Rik <rik5>
Group administrator
Fri 02 Sep 2016 03:58:48 AM UTC, original submission:  

There are three non-function m-files comma.m, semicolon.m, paren.m as helper on operators.

But the doc-string in function "help" only mentions two of them, "comma" and "semicolon".


>>  help help
'help' is a function from the file /usr/share/octave/4.0.3/m/help/help.m

 -- Command: help NAME
 -- Command: help '--list'
 -- Command: help '.'
 -- Command: help
     Display the help text for NAME.

     ......

     The help command can provide information about most operators, for
     example 'help +', but not the comma and semicolon characters which
     are used by the Octave interpreter as command separators.  For help
     on either of these type 'help comma' or 'help semicolon'.


Should it mention "paren" for operator parentheses as well for completeness?

Anonymous

 

(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 rik5 (Posted a comment)
  • -email is unavailable- added by None (Submitted the item)
  •  

    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.

     

    Follows 1 latest change.

    Date Changed by Updated Field Previous Value => Replaced by
    2016-09-02 rik5 Open/ClosedOpen Closed

    Back to the top

    Powered by Savane 3.13-d3ae.
    Corresponding source code