[Octave-bug-tracker] [bug #31905] Doc : 'help' no longer documented correctly

[John W. Eaton]

Follow-up Comment #1, bug #31905 (project octave):

The text you are referring to is


In order to get good help you first need to know the name of the command
that you want to use.  This name of the function may not always be
obvious, but a good place to start is to just type @code{help}.
This will show you all the operators, reserved words, functions,
built-in variables, and function files.  An alternative is to search the
documentation using the @code{lookfor} function.  This function is
described in @ref{Getting Help}.


so I can see why you didn't quickly fix this...

Perhaps we need a categorical list of functions?  Then we could say something
like


In order to get good help you first need to know the name of the command
that you want to use.  The name of the function may not always be
obvious, but a good place to start is to look in the categorical list of
functions, @ref{Categorical List of Functions}.  An alternative is to search
the
documentation using the @code{lookfor} function.  This function is
described in @ref{Getting Help}.


To quickly generate a list of functions by category, we could start by just
doing something like


for f in *.txi; do
  echo "$f:"
  sed -n 's/@DOCSTRING(([^)]*))/  1/p' $f | sort
done


and then generate subcategories by hand.

Longer term, we might add @category{} tags to the docstrings themselves so we
can generate the entire list automatically.


    _______________________________________________________

Reply to this item at:

  <http://savannah.gnu.org/bugs/?31905>

_______________________________________________
  Message sent via/by Savannah
  http://savannah.gnu.org/