> help 'assert' > help 'boxopen' the verb could be named nb :
'' nb 'assert' NB. find and report all lines with "assert" 'NB. about' nb 'assert' NB. find and report lines with "assert" and "NB. about" 'NB.' nb 'assert' NB. find and report lines with "assert" and "NB." 'NB. a' nb '' NB. find and report lines with "NB. a" nb '' NB. find and report lines with "NB." 2008/3/18, Sherlock, Ric <[EMAIL PROTECTED]>: > > ---Oleg Kobchenko wrote: > > --- "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: > > > I think this would be a great addition - especially for new users. I > remember working out early on that I could just type the name of a verb in > the IDE and its definition would be displayed, but I found it frustrating > that I wasn't able to see the documentation for it. > > I'd vote for calling the new verb "help" despite the fact that it isn't > consistent with scriptdoc. I think that would be more "discoverable". i.e. > help 'assert' > help 'boxopen' > > ---------------------------------------------------------------------- > For information about J forums see http://www.jsoftware.com/forums.htm > -- Björn Helgason, Verkfræðingur Fugl&Fiskur ehf, Fornustekkum II, 781 Hornafirði Po Box 127,801 Selfoss , t-póst: [EMAIL PROTECTED] gsm: +3546985532 Landslags og skrúðgarðagerð, gröfuþjónusta http://groups.google.com/group/J-Programming Tæknikunnátta höndlar hið flókna, sköpunargáfa er meistari einfaldleikans góður kennari getur stigið á tær án þess að glansinn fari af skónum /|_ .-----------------------------------. ,' .\ / | Með léttri lund verður | ,--' _,' | Dagurinn í dag | / / | Enn betri en gærdagurinn | ( -. | `-----------------------------------' | ) | (\_ _/) (`-. '--.) (='.'=) `. )----' (")_(")
---------------------------------------------------------------------- For information about J forums see http://www.jsoftware.com/forums.htm
