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.

Submitted by:  Josef Vukovic <josef>
Submitted on:  Mon 20 Dec 2010 09:55:42 AM UTC  
 
Category: InterpreterSeverity: 3 - Normal
Priority: 3 - LowItem Group: Incorrect Result
Status: FixedAssigned to: None
Originator Name: Josef VukovicOpen/Closed: Closed
Release: 3.2.2Operating System: GNU/Linux

Add a New Comment(Rich Markup)
   

You are not logged in

Please log in, so followups can be emailed to you.

 

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>
Project 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>
Project 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>
Project 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 File(s):
   
   
Comment:
   

No files currently attached

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -unavailable- added by rik5 (Posted a comment)
  • -unavailable- added by dbateman (Posted a comment)
  • -unavailable- added by jwe (Posted a comment)
  • -unavailable- added by josef (Submitted the item)
  •  

    Do you think this task is very important?
    If so, you can click here to add your encouragement to it.
    This task has 0 encouragements so far.

    Only project members can vote.

     

    Please enter the title of George Orwell's famous dystopian book (it's a date):

     

     

    Follow 3 latest changes.

    Date Changed By Updated Field Previous Value => Replaced By
    Thu 17 Oct 2013 06:08:11 PM UTCrik5Open/ClosedOpen=>Closed
    Thu 29 Aug 2013 08:24:47 PM UTCrik5StatusNone=>Fixed
    Tue 21 Dec 2010 04:32:39 AM UTCjwePriority5 - Normal=>3 - Low

    Back to the top


    Powered by Savane 3.1-cleanup1