Mercurial > octave
changeset 23047:97a9fd0af57b stable
doc: Don't use @code in @deftypefn because it expands badly in plain text format.
* load-save.cc (Fsave): Remove @code from around "-" option. Use @qcode instead around "v1", "v2" arguments. Use commas to separate arguments in functional calling form.
* help.m: Remove @code from around "." and "--help" options.
author | Rik <rik@octave.org> |
---|---|
date | Sun, 15 Jan 2017 08:07:31 -0800 |
parents | 1c98489534aa |
children | 7351f2c93389 |
files | libinterp/corefcn/load-save.cc scripts/help/help.m |
diffstat | 2 files changed, 5 insertions(+), 5 deletions(-) [+] |
line wrap: on
line diff
--- a/libinterp/corefcn/load-save.cc Fri Jan 13 15:41:04 2017 -0800 +++ b/libinterp/corefcn/load-save.cc Sun Jan 15 08:07:31 2017 -0800 @@ -1450,8 +1450,8 @@ @deftypefnx {} {} save options file @deftypefnx {} {} save options file @var{v1} @var{v2} @dots{} @deftypefnx {} {} save options file -struct @var{STRUCT} @var{f1} @var{f2} @dots{} -@deftypefnx {} {} save @code{"-"} @var{v1} @var{v2} @dots{} -@deftypefnx {} {@var{s} =} save (@code{"-"} @var{v1} @var{v2} @dots{}) +@deftypefnx {} {} save - @var{v1} @var{v2} @dots{} +@deftypefnx {} {@var{str} =} save ("-", @qcode{"@var{v1}"}, @qcode{"@var{v2}"}, @dots{}) Save the named variables @var{v1}, @var{v2}, @dots{}, in the file @var{file}.
--- a/scripts/help/help.m Fri Jan 13 15:41:04 2017 -0800 +++ b/scripts/help/help.m Sun Jan 15 08:07:31 2017 -0800 @@ -18,8 +18,8 @@ ## -*- texinfo -*- ## @deftypefn {} {} help @var{name} -## @deftypefnx {} {} help @code{--list} -## @deftypefnx {} {} help @code{.} +## @deftypefnx {} {} help --list +## @deftypefnx {} {} help . ## @deftypefnx {} {} help ## Display the help text for @var{name}. ## @@ -53,7 +53,7 @@ help NAME\n\ \n\ (replace NAME with the name of the command or function you would\n\ - like to learn more about; for an operator, enclose NAME in quotes).\n\ + like to learn more about; for an operator, enclose \"NAME\" in quotes).\n\ \n\ For a more detailed introduction to GNU Octave, consult the manual.\n\ The manual may be read from the prompt by typing\n\