bugGNU Octave - Bugs: bug #31905, Doc : 'help' no longer documented...

 
 

bug #31905: Doc : 'help' no longer documented correctly

Submitted by:  Rik <rik5>
Submitted on:  Fri 17 Dec 2010 05:24:16 PM UTC  
 
Category: NoneSeverity: 4 - Important
Priority: 5 - NormalItem Group: Documentation
Status: NoneAssigned to: None
Originator Name: Open/Closed: Closed
Release: devOperating 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 20 Jan 2011 05:39:28 AM UTC, comment #4:

Looks good. Closing this issue.

Rik <rik5>
Project Administrator
Wed 19 Jan 2011 10:09:22 AM UTC, comment #3:

I checked in the following changeset:

http://hg.savannah.gnu.org/hgweb/octave/rev/21c3e1370b82

It adds a --list option for the help command to allow it to list all available operators, keywords, built-in functions, and functions on the path in the current session of Octave. I also edited the text in the manual to point to the --list option.

OK? If so, then please close this report.

John W. Eaton <jwe>
Project Administrator
Mon 27 Dec 2010 06:09:21 AM UTC, comment #2:

I like the idea of categories, but it seems like it might be a lot to implement just now ahead of the 3.4 release. What about having a function which simply listed the user-visible functions? This would have the advantage of capturing user scripts and Octave-Forge scripts which wouldn't necessarily be in the @ref{Categorical List of Functions}.

A simple template for the function list might be

Rik <rik5>
Project Administrator
Fri 17 Dec 2010 06:39:51 PM UTC, comment #1:

The text you are referring to is

so I can see why you didn't quickly fix this...

Perhaps we need a categorical list of functions? Then we could say something like

To quickly generate a list of functions by category, we could start by just doing something like

and then generate subcategories by hand.

Longer term, we might add @category{} tags to the docstrings themselves so we can generate the entire list automatically.

John W. Eaton <jwe>
Project Administrator
Fri 17 Dec 2010 05:24:16 PM UTC, original submission:

Section 1.2.8 in intro.txi documents the old behavior of help which, when called without arguments, produced a list of available functions.

Rik <rik5>
Project Administrator

 

(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 jwe (Posted a comment)
  • -unavailable- added by rik5 (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):

     

     

    Follows 1 latest change.

    Date Changed By Updated Field Previous Value => Replaced By
    Thu 20 Jan 2011 05:39:28 AM UTCrik5Open/ClosedOpen=>Closed

    Back to the top


    Powered by Savane 3.1-cleanup1