changeset 30354:c980f938fdd8 stable

doc: grammarcheck C++ files in libinterp/ directory ahead of 7.1 release. * __isprimelarge__.cc, defaults.cc, input.cc, jsondecode.cc, oct-hist.cc, qr.cc, ov.cc: grammarcheck C++ files ahead of 7.1 release.
author Rik <rik@octave.org>
date Wed, 24 Nov 2021 19:42:29 -0800
parents 212461a26e9c
children 6a6efd7bb3ec
files libinterp/corefcn/__isprimelarge__.cc libinterp/corefcn/defaults.cc libinterp/corefcn/input.cc libinterp/corefcn/jsondecode.cc libinterp/corefcn/oct-hist.cc libinterp/corefcn/qr.cc libinterp/octave-value/ov.cc
diffstat 7 files changed, 18 insertions(+), 18 deletions(-) [+]
line wrap: on
line diff
--- a/libinterp/corefcn/__isprimelarge__.cc	Wed Nov 24 14:57:21 2021 -0800
+++ b/libinterp/corefcn/__isprimelarge__.cc	Wed Nov 24 19:42:29 2021 -0800
@@ -148,9 +148,9 @@
 
 DEFUN (__isprimelarge__, args, ,
        doc: /* -*- texinfo -*-
-@deftypefn  {} {@var{x} =} __isprimelarge__ (@var{n})
+@deftypefn {} {@var{x} =} __isprimelarge__ (@var{n})
 Use the Miller-Rabin test to find out whether the elements of N are prime or
-composite. The input N is required to be a vector or array of 64-bit integers.
+composite.  The input N is required to be a vector or array of 64-bit integers.
 You should call isprime(N) instead of directly calling this function.
 
 @seealso{isprime, factor}
--- a/libinterp/corefcn/defaults.cc	Wed Nov 24 14:57:21 2021 -0800
+++ b/libinterp/corefcn/defaults.cc	Wed Nov 24 19:42:29 2021 -0800
@@ -508,7 +508,7 @@
 
 DEFUN (user_config_dir, args, ,
        doc: /* -*- texinfo -*-
-@deftypefn {} {cfg_dir = } user_config_dir ()
+@deftypefn {} {cfg_dir =} user_config_dir ()
 Return the (platform-specific) directory for user configuration.
 @seealso{user_data_dir}
 @end deftypefn */)
@@ -526,7 +526,7 @@
 
 DEFUN (user_data_dir, args, ,
        doc: /* -*- texinfo -*-
-@deftypefn {} {data_dir = } user_data_dir ()
+@deftypefn {} {data_dir =} user_data_dir ()
 Return the (platform-specific) directory for user data.
 @seealso{user_config_dir}
 @end deftypefn */)
--- a/libinterp/corefcn/input.cc	Wed Nov 24 14:57:21 2021 -0800
+++ b/libinterp/corefcn/input.cc	Wed Nov 24 19:42:29 2021 -0800
@@ -1581,7 +1581,7 @@
 
 DEFMETHOD (dir_encoding, interp, args, nargout,
            doc: /* -*- texinfo -*-
-@deftypefn {}  {@var{current_encoding} =} dir_encoding (@var{dir})
+@deftypefn  {} {@var{current_encoding} =} dir_encoding (@var{dir})
 @deftypefnx {} {@var{prev_encoding} =} dir_encoding (@var{dir}, @var{encoding})
 @deftypefnx {} {} dir_encoding (@dots{})
 Set and query the @var{encoding} that is used for reading m-files in @var{dir}.
@@ -1591,7 +1591,7 @@
 The string @var{DIR} must match the form how the directory would appear in the
 load path.
 
-The @var{encoding} must be a valid encoding identifier or @code{"delete"}.  In
+The @var{encoding} must be a valid encoding identifier or @qcode{"delete"}.  In
 the latter case, the (globally set) m-file encoding will be used for the given
 @var{dir}.
 
@@ -1602,7 +1602,7 @@
 The directory encoding is automatically read from the file @file{.oct-config}
 when a new path is added to the load path (for example with @code{addpath}).
 To set the encoding for all files in the same folder, that file must contain
-a line starting with @code{"encoding="} followed by the encoding identifier.
+a line starting with @qcode{"encoding="} followed by the encoding identifier.
 
 For example to set the file encoding for all files in the same folder to
 ISO 8859-1 (Latin-1), create a file @file{.oct-config} with the following
--- a/libinterp/corefcn/jsondecode.cc	Wed Nov 24 14:57:21 2021 -0800
+++ b/libinterp/corefcn/jsondecode.cc	Wed Nov 24 19:42:29 2021 -0800
@@ -501,9 +501,9 @@
 @qcode{"Prefix"}, see
 @ref{XREFmatlab_lang_makeValidName,,matlab.lang.makeValidName}.
 
-If the value of the option @qcode{\"makeValidName\"} is false then names
+If the value of the option @qcode{"makeValidName"} is false then names
 will not be changed by @code{matlab.lang.makeValidName} and the
-@qcode{\"ReplacementStyle\"} and @qcode{\"Prefix\"} options will be ignored.
+@qcode{"ReplacementStyle"} and @qcode{\"Prefix\"} options will be ignored.
 
 NOTE: Decoding and encoding JSON text is not guaranteed to reproduce the
 original text as some names may be changed by @code{matlab.lang.makeValidName}.
--- a/libinterp/corefcn/oct-hist.cc	Wed Nov 24 14:57:21 2021 -0800
+++ b/libinterp/corefcn/oct-hist.cc	Wed Nov 24 19:42:29 2021 -0800
@@ -821,9 +821,9 @@
 
 The default value is @file{@w{@env{$DATA}}/octave/history}, where
 @w{@env{$DATA}} is the platform-specific location for (roaming) user data files
-(e.g. @w{@env{$XDG_DATA_HOME}} or, if that is not set, @file{~/.local/share} on
-Unix-like operating systems or @w{@env{%APPDATA%}} on Windows).  The default
-value may be overridden by the environment variable @w{@env{OCTAVE_HISTFILE}}.
+(e.g., @w{@env{$XDG_DATA_HOME}} or, if that is not set, @file{~/.local/share} on
+Unix-like operating systems or @w{@env{%APPDATA%}} on Windows).  The default value may
+be overridden by the environment variable @w{@env{OCTAVE_HISTFILE}}.
 
 Programming Notes:
 
--- a/libinterp/corefcn/qr.cc	Wed Nov 24 14:57:21 2021 -0800
+++ b/libinterp/corefcn/qr.cc	Wed Nov 24 19:42:29 2021 -0800
@@ -231,11 +231,11 @@
 @end example
 
 If the input matrix @var{A} is sparse, the sparse QR@tie{}factorization
-is computed by using @sc{SPQR} or @sc{CXSparse} (e.g., if @sc{SPQR} is not
+is computed by using @sc{SPQR} or @sc{cxsparse} (e.g., if @sc{SPQR} is not
 available).  Because the matrix @var{Q} is, in general, a full matrix, it is
 recommended to request only one return value @var{R}.  In that case, the
-computation avoids the construction of @var{Q} and returns a sparse @var{R} such
-that @code{@var{R} = chol (@var{A}' * @var{A})}.
+computation avoids the construction of @var{Q} and returns a sparse @var{R} such that
+@code{@var{R} = chol (@var{A}' * @var{A})}.
 
 If @var{A} is dense, an additional matrix @var{B} is supplied and two
 return values are requested, then @code{qr} returns @var{C}, where
@@ -261,7 +261,7 @@
 
 If the final argument is the string @qcode{"vector"} then @var{P} is a
 permutation vector (of the columns of @var{A}) instead of a permutation
-matrix. In this case, the defining relationship is:
+matrix.  In this case, the defining relationship is:
 
 @example
 @var{Q} * @var{R} = @var{A}(:, @var{P})
@@ -276,7 +276,7 @@
 columns in @var{Q} and omit the zeros in @var{R}.  If M @leq{} N, there is no
 difference between the economy and standard factorizations.  When calculating
 an @qcode{"economy"} factorization and @var{A} is dense, the output @var{P} is
-always a vector rather than a matrix. If @var{A} is sparse, output
+always a vector rather than a matrix.  If @var{A} is sparse, output
 @var{P} is a sparse permutation matrix.
 
 Background: The QR factorization has applications in the solution of least
--- a/libinterp/octave-value/ov.cc	Wed Nov 24 14:57:21 2021 -0800
+++ b/libinterp/octave-value/ov.cc	Wed Nov 24 19:42:29 2021 -0800
@@ -3696,7 +3696,7 @@
 diagonal matrices as full matrices.
 
 When called from inside a function with the @qcode{"local"} option, the setting
-is changed locally for the function and any subroutines it calls. The original
+is changed locally for the function and any subroutines it calls.  The original
 setting is restored when exiting the function.
 @seealso{optimize_range, optimize_permutation_matrix}
 @end deftypefn */)