Mercurial > octave
changeset 31593:0f93c3a756f7 stable
doc: grammarcheck documentation ahead of 8.1 release.
* interpreter.cc, load-path.cc, warning_ids.m, __memoize__.m,
print.m: grammarcheck documentation ahead of 8.1 release.
| author | Rik <rik@octave.org> |
|---|---|
| date | Tue, 29 Nov 2022 15:58:49 -0800 |
| parents | d3ddf7be0235 |
| children | a3d8915b9f87 |
| files | libinterp/corefcn/interpreter.cc libinterp/corefcn/load-path.cc scripts/help/warning_ids.m scripts/miscellaneous/private/__memoize__.m scripts/plot/util/print.m |
| diffstat | 5 files changed, 9 insertions(+), 8 deletions(-) [+] |
line wrap: on
line diff
--- a/libinterp/corefcn/interpreter.cc Tue Nov 29 13:15:07 2022 -0800 +++ b/libinterp/corefcn/interpreter.cc Tue Nov 29 15:58:49 2022 -0800 @@ -308,7 +308,7 @@ DEFMETHOD (__traditional__, interp, , , doc: /* -*- texinfo -*- @deftypefn {} {@var{tf} =} __traditional__ () -Return true if Octave was invoked with the @env{--traditional} option. +Return true if Octave was invoked with the @w{@env{--traditional}} option. @end deftypefn */) { return ovl (interp.traditional ());
--- a/libinterp/corefcn/load-path.cc Tue Nov 29 13:15:07 2022 -0800 +++ b/libinterp/corefcn/load-path.cc Tue Nov 29 15:58:49 2022 -0800 @@ -2515,7 +2515,7 @@ doc: /* -*- texinfo -*- @deftypefn {} {@var{pathstr} =} command_line_path () Return the path argument given to Octave at the command line when the -interpreter was started (@env{--path @var{arg}}). +interpreter was started (@w{@env{--path @var{arg}}}). @seealso{path, addpath, rmpath, genpath, pathdef, savepath, pathsep} @end deftypefn */)
--- a/scripts/help/warning_ids.m Tue Nov 29 13:15:07 2022 -0800 +++ b/scripts/help/warning_ids.m Tue Nov 29 15:58:49 2022 -0800 @@ -434,7 +434,8 @@ ## ## @item Octave:LaTeX:internal-error ## If the @code{Octave:LaTeX:internal-error} warning is enabled, a warning is -## printed whenever the LaTeX renderer for text in plots encounters an issue. +## printed whenever the @LaTeX{} renderer for text in plots encounters an +## issue. ## By default, the @code{Octave:LaTeX:internal-error} warning is enabled. ## ## @item Octave:unimplemented-matlab-functionality @@ -458,5 +459,5 @@ endfunction -## Mark file as being tested. No real test needed for a documentation .m file +## Mark file as tested. No test needed for a documentation m-file. %!assert (1)
--- a/scripts/miscellaneous/private/__memoize__.m Tue Nov 29 13:15:07 2022 -0800 +++ b/scripts/miscellaneous/private/__memoize__.m Tue Nov 29 15:58:49 2022 -0800 @@ -24,8 +24,8 @@ ######################################################################## ## -*- texinfo -*- -## @deftypefn {} {@var{mem_fcn_handle} =} __memoize__ (@var{fcn_handle}) -## @deftypefn {} {} __memoize__ () +## @deftypefn {} {@var{mem_fcn_handle} =} __memoize__ (@var{fcn_handle}) +## @deftypefn {} {} __memoize__ () ## Internal function used by @code{memoize}. ## ## @seealso{clearAllMemoizedCaches, memoize}
--- a/scripts/plot/util/print.m Tue Nov 29 13:15:07 2022 -0800 +++ b/scripts/plot/util/print.m Tue Nov 29 15:58:49 2022 -0800 @@ -127,8 +127,8 @@ ## JPEG) and @qcode{"painters"} for vector formats (e.g., PDF)@. These options ## are only supported for the "qt" graphics toolkit. ## -## @item -svgconvert (default) -## @item -nosvgconvert +## @item -svgconvert (default) +## @itemx -nosvgconvert ## When using the @option{-painters} renderer, this enables or disables the ## SVG based backend toolchain with enhanced characteristics: ##