octave-maintainers
[Top][All Lists]
Advanced

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

Re: Help message "tags" about additional help somewhat redundant and irr


From: Daniel J Sebald
Subject: Re: Help message "tags" about additional help somewhat redundant and irrelevant
Date: Thu, 12 Jan 2017 14:56:52 -0600
User-agent: Mozilla/5.0 (X11; Linux x86_64; rv:45.0) Gecko/20100101 Thunderbird/45.5.1

On 01/12/2017 11:08 AM, Daniel J Sebald wrote:
On 01/12/2017 01:36 AM, Mike Miller wrote:
On Wed, Jan 11, 2017 at 17:17:03 -0600, Daniel J Sebald wrote:
Anyway, it just seems to me that after short use of Octave, that
"Additional
help..." text becomes really redundant.  I wouldn't call it annoying,
but it
detracts from the cleanliness of the display, i.e., clutter.

I think you're looking for `suppress_verbose_help_message(true)`.

Yes, thank you.  This function should be listed in the see-also portion
of "help help":

See also: doc, lookfor, which, info, suppress_verbose_help_message.

As an alternative, verbosity could maybe be an option:

 -- help NAME
 -- help '--list'
 -- help '.'
 -- help
 -- help '--noverbose'

but the suppress_verbose_help_message() is geared to function form
because it returns the present state which couldn't be done with an option.

BTW, help() currently does have a return value (it returns text):

octave:33> helptext = help('help');
octave:34> helptext(1:10)
ans =

 -- help N

If that is the case, suppress_verbose_help_message() could be incorporated with something like

 -- [TEXT, VERB] = help(...);

where VERB is verbosity.

Dan



reply via email to

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