bugGNU Octave - Bugs: bug #31935, help do_nothing prints not the...

 
 

bug #31935: help do_nothing prints not the entire documentation while the function beeing written interactively.

Submitter:  Josef Vukovic <josef>
Submitted:  Mon 20 Dec 2010 09:55:42 AM UTC
   
 
Category:  Interpreter Severity:  3 - Normal
Priority:  3 - Low Item Group:  Incorrect Result
Status:  Fixed Assigned to:  None
Originator Name:  Josef Vukovic Open/Closed:  * Closed
Release:  * 3.2.2 Operating System:  * GNU/Linux
Fixed Release:  None Planned Release:  None
* Mandatory Fields

Add a New Comment Rich Markup
   

Thu 29 Aug 2013 08:24:47 PM UTC, comment #5: 

This has been fixed somewhere along the way with the introduction of the new parser.  The fix will be available in the 3.8 release of Octave.

Rik <rik5>
Group administrator
Tue 21 Dec 2010 08:41:50 PM UTC, comment #4: 

Up to 3.0.x we had the "document" function that could add a help string to an arbitrary symbol. It seems to have been removed in 3.2.x when the m-file help system was added.

Perhaps the best way to address this report is to try and reintroduce the "document" function

D.

David Bateman <dbateman>
Group Member
Tue 21 Dec 2010 04:32:39 AM UTC, comment #3: 

I would guess that most functions defined on the command line don't have doc strings, so I'm lowering the priority of this report.

There is already a comment about the problem in the function grab_comment_block in src/lex.ll.

John W. Eaton <jwe>
Group administrator
Mon 20 Dec 2010 10:14:54 AM UTC, comment #2: 

This don't happens when the function do_nothing is defined
in a file (e.g. in the .ocraverc)
Then invoking help do_nothing prints all three documentationstrings.



Josef Vukovic <josef>
Mon 20 Dec 2010 10:10:37 AM UTC, comment #1: 

Definign a Function interactivley from the interpreter

octave:3> function do_nothing()

> # usage: do_nothing()
> # This function
> # does nothing
> endfunction


And invoking help do_nothing prints only the first
documentationstring usage: do_nothing() and not the other two


Josef Vukovic <josef>
Mon 20 Dec 2010 09:55:42 AM UTC, original submission:  

Bug in the documentation string of function

Josef Vukovic <josef>

 

(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 dbateman (Posted a comment)
  • -email is unavailable- added by jwe (Posted a comment)
  • -email is unavailable- added by josef (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.

     

    Follow 3 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2013-10-17 rik5 Open/ClosedOpen Closed
    2013-08-29 rik5 StatusNone Fixed
    2010-12-21 jwe Priority5 - Normal 3 - Low

    Back to the top

    Powered by Savane 3.13-02a9.
    Corresponding source code