bugGNU Octave - Bugs: bug #48041, classdef: `help myclass` messes up...

 
 

bug #48041: classdef: `help myclass` messes up `help @myclass/method`

Submitter:  Colin Macdonald <cbm>
Submitted:  Fri 27 May 2016 08:48:30 PM UTC
 
Category:  Interpreter Severity:  1 - Wish
Priority:  3 - Low Item Group:  Feature Request
Status:  Confirmed Assigned to:  None
Originator Name:  Open/Closed:  * Open
Release:  * dev Operating System:  * Any
* Mandatory Fields

Add a New Comment (Rich Markup)
   

Comment Type & Canned Response:
       

 

Sun 24 Jul 2022 06:16:49 AM UTC, comment #3: 

> the alternate syntax 'help myclass.method' works universally now


I'm not sure this is so.  Not for old-style (https://savannah.gnu.org/bugs/?62804). I also found this summary: https://savannah.gnu.org/bugs/index.php?61521

Colin Macdonald <cbm>
Fri 04 Jun 2021 07:46:29 PM UTC, comment #2: 

It's still true that calling 'help myclass' makes 'help @myclass/method' not work, unless it has already been called before. However, the alternate syntax 'help myclass.method' works universally now, so that's a useful workaround.

It's not clear to me whether the '@myclass/method' form should only work for methods actually defined in a subdirectory, or should it also work for methods defined and documented inline in the classdef block?

Mike Miller <mtmiller>
Project Administrator
Sun 29 May 2016 04:44:11 PM UTC, comment #1: 

Confirmed here, calling the class constructor, as opposed to `help foo`, also masks the help on any other methods.

Mike Miller <mtmiller>
Project Administrator
Fri 27 May 2016 08:48:30 PM UTC, original submission:  

`help` interacts badly with classdef-style classes.  After I do `help classname`, I cannot access the help of any methods (except ones I accessed before `help classname`.

>> help pyobject
error: help: 'pyobject' is not documented
>> help @pyobject/display
error: help: '@pyobject/display' is not documented
>> help @pyobject/dummy
error: help: '@pyobject/dummy' is not documented

("@pyobject/dummy" is documented).

But if I restart Octave and try the commands in a different order:

>> help @pyobject/display
'@pyobject/display' is a function from the file /home/cbm/src/pytave.hg.mine/@pyobject/display.m

 -- Method on @pyobject: display (X)
     Custom display for pyobjects.

  ---- 8< -----

>> help pyobject
error: help: 'pyobject' is not documented
>> help @pyobject/dummy
error: help: '@pyobject/dummy' is not documented

Colin Macdonald <cbm>

 

(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

Digest:
   bug dependencies.

 

Carbon-Copy List
  • -email is unavailable- added by mtmiller (Posted a comment)
  • -email is unavailable- added by cbm (Submitted the item)
  • -email is unavailable- added by cbm
  • -email is unavailable- added by cbm
  •  

    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 project members can vote.

     

     

     

     

    Follow 7 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2021-06-04 mtmiller Severity3 - Normal 1 - Wish
        Priority5 - Normal 3 - Low
        Item GroupIncorrect Result Feature Request
    2017-09-19 pantxo Dependencies- bugs #52058 is dependent
    2016-05-29 mtmiller StatusNone Confirmed
    2016-05-27 cbm Carbon-Copy- Added mtmiller
        Carbon-Copy- Added goffioul

    Back to the top


    Powered by Savane 3.9