octave-maintainers
[Top][All Lists]
Advanced

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

Help strings in the text body of the manual


From: Pantxo Diribarne
Subject: Help strings in the text body of the manual
Date: Sun, 24 Apr 2016 21:41:24 +0200

Hi,

I find some sections of the manual hardly readable due to the verbatim inclusion of lists of function help strings.
At the very least having separators and/or a visual hint of what is the text body and what is a help string would help.

For readability though I would even vote for having all those help strings stored in an appendix, with a page break between each,  and only hyperlinks (and usage examples) in the body of the manual.
This would even allow having demo figures appended to the help strings, as is done by generate_html (see e.g  http://octave.sourceforge.net/octave/function/contour.html).

Thoughts?

Pantxo


reply via email to

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