Re: [Bug-apl] )HELP for defined functions

[Louis de Forcrand]

Hi,

Great work Jürgen, Alexey, and all others involved.

May I suggest adding the type of data to its help info? (ie: numeric, literal, mixed)

Thanks a lot,

Louis

On 20 Apr 2017, at 18:22, Juergen Sauermann <address@hidden> wrote:

Hi,

I have implemented Elias' earlier proposal for )HELP with defined functions (actually all kinds
of user defined names).

If there is a name, say NAME, in your workspace, then

      ]HELP NAME

should provide some information about NAME, eg:

      NAME←3 3⍴0
      )HELP NAME
symbol NAME is a variable:
    Rank:  2
    Shape: 3 3
    Depth: 1

If NAME is a function, then code extraction comments are shown:

            ∇NAME B
[1] ⍝⍝ code extraction comment (always shown)
[2] ⍝ normal comment (not shown unless in toronto mode)
[3] 1 2 3   ⍝ APL code ends toronto mode
[4] ⍝. toronto code extraction comment
[5] ⍝ normal comment (shown because in toronto mode)
[6] 1 2 3
[7]  ∇
     
      )HELP NAME
symbol NAME is a monadic defined function:
    Header: NAME B
    ⍝⍝ code extraction comment (always shown)
    ⍝. toronto code extraction comment
    ⍝ normal comment (shown because in toronto mode)

Finally, )HELP is subject to tab expansion; tab with ]HELP only shows the APL primitives and,
either the first character of all names (if there are many) or all names (if there are not too many).

Tab with )HELP XXX shows all names starting with XXX.

I hope this implements everything that was discussed earlier. SVN 926.

/// Jürgen