Mercurial > hg > octave-lyh

comparison scripts/help/lookfor.m @ 9035:57649dcecb55

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Documentation cleanup of basics.texi Added documentation for new block comments feature Spellcheck Miscellaneous language cleanup for clarity
author Rik <rdrider0-list@yahoo.com>
date Sat, 21 Mar 2009 08:29:37 -0700
parents b8ed0262b11e
children c0cef1436788
comparison
equal deleted inserted replaced
9034:52515efc50c0 9035:57649dcecb55
15 ## <http://www.gnu.org/licenses/>. 15 ## <http://www.gnu.org/licenses/>.
16 16
17 ## -*- texinfo -*- 17 ## -*- texinfo -*-
18 ## @deftypefn {Command} lookfor @var{str} 18 ## @deftypefn {Command} lookfor @var{str}
19 ## @deftypefnx {Command} lookfor -all @var{str} 19 ## @deftypefnx {Command} lookfor -all @var{str}
20 ## @deftypefnx {Function} {[@var{fun}, @var{helpstring}] = } lookfor (@var{str}) 20 ## @deftypefnx {Function} {[@var{fun}, @var{helpstring}] =} lookfor (@var{str})
21 ## @deftypefnx {Function} {[@var{fun}, @var{helpstring}] = } lookfor ('-all', @var{str}) 21 ## @deftypefnx {Function} {[@var{fun}, @var{helpstring}] =} lookfor ('-all', @var{str})
22 ## Search for the string @var{str} in all of the functions found in the 22 ## Search for the string @var{str} in all of the functions found in the
23 ## function search path. By default @code{lookfor} searches for @var{str} 23 ## function search path. By default @code{lookfor} searches for @var{str}
24 ## in the first sentence of the help string of each function found. The entire 24 ## in the first sentence of the help string of each function found. The entire
25 ## help string of each function found in the path can be searched if 25 ## help string of each function found in the path can be searched if
26 ## the '-all' argument is supplied. All searches are case insensitive. 26 ## the '-all' argument is supplied. All searches are case insensitive.
27 ## 27 ##
28 ## Called with no output arguments, @code{lookfor} prints the list of matching 28 ## Called with no output arguments, @code{lookfor} prints the list of matching
29 ## functions to the terminal. Otherwise the output arguments @var{fun} and 29 ## functions to the terminal. Otherwise the output arguments @var{fun} and
30 ## @var{helpstring} define the matching functions and the first sentence of 30 ## @var{helpstring} define the matching functions and the first sentence of
31 ## each of their help strings. 31 ## each of their help strings.
32 ## 32 ##
33 ## Note that the ability of @code{lookfor} to correctly identify the first 33 ## Note that the ability of @code{lookfor} to correctly identify the first
34 ## sentence of the help of the functions is dependent on the format of the 34 ## sentence of the help of the functions is dependent on the format of the
35 ## functions help. All of the functions in Octave itself will correctly 35 ## functions help. All of the functions in Octave itself will correctly
36 ## find the first sentence, but the same can not be guaranteed for other 36 ## find the first sentence, but the same can not be guaranteed for other
37 ## functions. Therefore the use of the '-all' argument might be necessary 37 ## functions. Therefore the use of the '-all' argument might be necessary
38 ## to find related functions that are not part of Octave. 38 ## to find related functions that are not part of Octave.
39 ## @seealso{help, which} 39 ## @seealso{help, which}
40 ## @end deftypefn 40 ## @end deftypefn
41 41
42 function [out_fun, out_help_text] = lookfor (str, extra) 42 function [out_fun, out_help_text] = lookfor (str, extra)