octave-bug-tracker
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[Octave-bug-tracker] [bug #52461] "help" subfunctions using "filemarker"


From: anonymous
Subject: [Octave-bug-tracker] [bug #52461] "help" subfunctions using "filemarker" seems not work
Date: Sun, 19 Nov 2017 21:32:02 -0500 (EST)
User-agent: Mozilla/5.0 (X11; Linux x86_64; rv:52.0) Gecko/20100101 Firefox/52.0

URL:
  <http://savannah.gnu.org/bugs/?52461>

                 Summary: "help" subfunctions using "filemarker" seems not
work
                 Project: GNU Octave
            Submitted by: None
            Submitted on: Mon 20 Nov 2017 02:32:01 AM UTC
                Category: None
                Severity: 3 - Normal
                Priority: 5 - Normal
              Item Group: None
                  Status: None
             Assigned to: None
         Originator Name: 
        Originator Email: address@hidden
             Open/Closed: Open
         Discussion Lock: Any
                 Release: 4.2.1
        Operating System: GNU/Linux

    _______________________________________________________

Details:

The docstring of "filemarker" says that

     By default this is the character '>'.  This can be used in a
     generic manner to interact with subfunctions.  For example,

          help (["myfunc", filemarker, "mysubfunc"])

     returns the help string associated with the subfunction 'mysubfunc'
     located in the file 'myfunc.m'.


Now for a file "func1.m"

$  cat func1.m 
%% help1
function y = func1 (x)
%% help1.1
  y = func2 (x);
endfunction

%% help2
function y = func2 (x)
%% help2.1
  y = x + 1;
endfunction


and in octave-cli

octave:63>  help func1
'func1' is a function from the file /home/user/func1.m

 help1

octave:64>  help func1>func2
error: help: 'func1>func2' is not documented
octave:64>  help func1>foo

 help1

octave:65>



Similar results can be got for the following commands (The outputs are too
long, so I do not paste them here)

help gallery
help gallery>cauchy
help gallery>foo


Besides, I searched the octave document but does not find the definition about
the docstring associated with a subfunction.

It's not a big deal because in reality it seems that we do not use the
docstring of a subfunction.




    _______________________________________________________

Reply to this item at:

  <http://savannah.gnu.org/bugs/?52461>

_______________________________________________
  Message sent via/by Savannah
  http://savannah.gnu.org/




reply via email to

[Prev in Thread] Current Thread [Next in Thread]