Mercurial > hg > octave-nkf
diff scripts/help/get_first_help_sentence.m @ 10793:be55736a0783
Grammarcheck the documentation from m-files.
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Sun, 18 Jul 2010 20:35:16 -0700 |
parents | 1bf0ce0930be |
children | 2c356a35d7f5 |
line wrap: on
line diff
--- a/scripts/help/get_first_help_sentence.m +++ b/scripts/help/get_first_help_sentence.m @@ -21,7 +21,8 @@ ## The function reads the first sentence of the help text of the function ## @var{name}. The first sentence is defined as the text after the function ## declaration until either the first period (".") or the first appearance of -## two consecutive end-lines ("\n\n"). The text is truncated to a maximum length +## two consecutive end-lines ("\n\n"). The text is truncated to a maximum +## length ## of @var{max_len}, which defaults to 80. ## ## The optional output argument @var{status} returns the status reported by