---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
