--- "Philip A. Viton" <[EMAIL PROTECTED]> wrote:
> Do we have a convention/utility for documenting and displaying help
> for a verb (as opposed to a script, ie scriptdoc)? I'd like to be
> able to do eg myverb 'help' or maybe myverb '?' and get a message
> about the verb. It's easy to set something like this up, but if we'd
> come up with a standard way I'd prefer to use it.
I don't believe there is one, but it should be easy to
extend scriptdoc to display help for just one name:
it already can locate a name (with Ctrl+F1 in FE).
It makes sense to preserve the existing documenting
conventions (NB.* above name).
For consistency with scriptdoc, it would be a verb
"namedoc" (akin to NAMEs and scriptDOC) with interface:
namedoc'assert'
assert (v) assert value is true
assertion failure if 0 e. y
e.g. 'invalid age' assert 0 <: age
namedoc'boxopen'
boxopen (v) box argument if open
boxxopen - box argument if open and # is not zero
e.g. if script=: 0!:0 @ boxopen, then either
script 'work.ijs' or script <'work.ijs'
use cutopen to allow multiple arguments.
____________________________________________________________________________________
Be a better friend, newshound, and
know-it-all with Yahoo! Mobile. Try it now.
http://mobile.yahoo.com/;_ylt=Ahu06i62sR8HDtDypao8Wcj9tAcJ
----------------------------------------------------------------------
For information about J forums see http://www.jsoftware.com/forums.htm
