Mercurial > octave
diff libinterp/corefcn/help.cc @ 27438:7db34a40cd23 stable
doc: Improve documentation for get_help_text, get_help_text_from_file.
* help.cc (Fget_help_text, Fget_help_text_from_file): Add period after end of
second sentence. Add @w{} macro to prevent "plain text" being broken across
a newline.
author | Rik <rik@octave.org> |
---|---|
date | Mon, 23 Sep 2019 13:15:22 -0700 |
parents | a7d21a6a7922 |
children | 15752c577f6d |
line wrap: on
line diff
--- a/libinterp/corefcn/help.cc Tue Sep 17 14:31:10 2019 -0700 +++ b/libinterp/corefcn/help.cc Mon Sep 23 13:15:22 2019 -0700 @@ -713,9 +713,9 @@ @deftypefn {} {[@var{text}, @var{format}] =} get_help_text (@var{name}) Return the raw help text of function @var{name}. -The raw help text is returned in @var{text} and the format in @var{format} -The format is a string which is one of @qcode{"texinfo"}, -@qcode{"html"}, or @qcode{"plain text"}. +The raw help text is returned in @var{text} and the format in @var{format}. +The format is a string which is one of @qcode{"texinfo"}, @qcode{"html"}, or +@w{@qcode{"plain text"}}. @seealso{get_help_text_from_file} @end deftypefn */) { @@ -738,9 +738,9 @@ @deftypefn {} {[@var{text}, @var{format}] =} get_help_text_from_file (@var{fname}) Return the raw help text from the file @var{fname}. -The raw help text is returned in @var{text} and the format in @var{format} -The format is a string which is one of @qcode{"texinfo"}, -@qcode{"html"}, or @qcode{"plain text"}. +The raw help text is returned in @var{text} and the format in @var{format}. +The format is a string which is one of @qcode{"texinfo"}, @qcode{"html"}, or +@w{@qcode{"plain text"}}. @seealso{get_help_text} @end deftypefn */) {