Mercurial > octave
changeset 24986:0b9e7fcaab91 stable
doc: grammarcheck docstrings in C++ files ahead of 4.4 release.
* defaults.cc, dirfns.cc, load-save.cc, pr-flt-fmt.cc, quadcc.cc, regexp.cc,
qr.cc: Use Octave conventions in documentation strings.
author | Rik <rik@octave.org> |
---|---|
date | Fri, 23 Mar 2018 10:29:45 -0700 |
parents | d85b2485af9e |
children | a895967fd5a7 |
files | libinterp/corefcn/defaults.cc libinterp/corefcn/dirfns.cc libinterp/corefcn/load-save.cc libinterp/corefcn/pr-flt-fmt.cc libinterp/corefcn/quadcc.cc libinterp/corefcn/regexp.cc libinterp/dldfcn/qr.cc |
diffstat | 7 files changed, 14 insertions(+), 11 deletions(-) [+] |
line wrap: on
line diff
--- a/libinterp/corefcn/defaults.cc Fri Mar 23 10:10:52 2018 -0700 +++ b/libinterp/corefcn/defaults.cc Fri Mar 23 10:29:45 2018 -0700 @@ -342,7 +342,7 @@ @deftypefn {} {} OCTAVE_HOME () Return the name of the top-level Octave installation directory for architecture-dependendent files. If not specified separately, the value -is the same as OCTAVE_HOME. OCTAVE_EXEC_HOME corresponds to the +is the same as OCTAVE_HOME@. OCTAVE_EXEC_HOME corresponds to the configuration variable @var{exec_prefix}. @seealso{EXEC_PATH, IMAGE_PATH, OCTAVE_HOME} @end deftypefn */)
--- a/libinterp/corefcn/dirfns.cc Fri Mar 23 10:10:52 2018 -0700 +++ b/libinterp/corefcn/dirfns.cc Fri Mar 23 10:29:45 2018 -0700 @@ -654,7 +654,7 @@ DEFUN (pathsep, args, , doc: /* -*- texinfo -*- -@deftypefn {} {@var{val} =} pathsep () +@deftypefn {} {@var{val} =} pathsep () Query the character used to separate directories in a path. @seealso{filesep} @end deftypefn */)
--- a/libinterp/corefcn/load-save.cc Fri Mar 23 10:10:52 2018 -0700 +++ b/libinterp/corefcn/load-save.cc Fri Mar 23 10:29:45 2018 -0700 @@ -1508,7 +1508,7 @@ Save a matrix in a text file without a header or any other information. The matrix must be 2-D and only the real part of any complex value is written to the file. Numbers are stored in single-precision format and separated by -spaces. Additional options for the @code{-ascii} format are +spaces. Additional options for the @option{-ascii} format are @table @code @item -double
--- a/libinterp/corefcn/pr-flt-fmt.cc Fri Mar 23 10:10:52 2018 -0700 +++ b/libinterp/corefcn/pr-flt-fmt.cc Fri Mar 23 10:29:45 2018 -0700 @@ -47,7 +47,7 @@ DEFUN (output_max_field_width, , , doc: /* -*- texinfo -*- -@deftypefn {} {} output_max_field_width +@deftypefn {} {} output_max_field_width This function is obsolete and will be removed from a future version of Octave. @end deftypefn */)
--- a/libinterp/corefcn/quadcc.cc Fri Mar 23 10:10:52 2018 -0700 +++ b/libinterp/corefcn/quadcc.cc Fri Mar 23 10:29:45 2018 -0700 @@ -1552,7 +1552,7 @@ quadrature rules. @c FIXME: Remove in Octave version 4.8 -Implementation Note: For Octave versions <= 4.2, @code{quadcc} accepted a +Implementation Note: For Octave versions @leq{} 4.2, @code{quadcc} accepted a single tolerance argument which specified the relative tolerance. For versions 4.4 and 4.6, @code{quadcc} will issue a warning when called with a single tolerance argument indicating that the meaning of this input has
--- a/libinterp/corefcn/regexp.cc Fri Mar 23 10:10:52 2018 -0700 +++ b/libinterp/corefcn/regexp.cc Fri Mar 23 10:29:45 2018 -0700 @@ -861,6 +861,7 @@ are zero or more @qcode{'b'} characters at positions 1 and end-of-string. @end table + Stack Limitation Note: Pattern searches are done with a recursive function which can overflow the program stack when there are a high number of matches. For example, @@ -869,6 +870,7 @@ @code{regexp (repmat ('a', 1, 1e5), '(a)+')} @end example +@noindent may lead to a segfault. As an alternative, consider constructing pattern searches that reduce the number of matches (e.g., by creatively using set complement), and then further processing the return variables (now reduced in
--- a/libinterp/dldfcn/qr.cc Fri Mar 23 10:10:52 2018 -0700 +++ b/libinterp/dldfcn/qr.cc Fri Mar 23 10:29:45 2018 -0700 @@ -226,12 +226,13 @@ The default, however, is to return a permutation matrix and this may be explicitly specified by using a final argument of @qcode{"matrix"}. -If the final argument is the scalar 0 an "economy" factorization is returned. -When the original matrix @var{A} has size MxN and M > N then the "economy" -factorization will calculate just N rows in @var{R} and N 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 "economy" -factorization the output @var{P} is always a vector rather than a matrix. +If the final argument is the scalar 0 an @qcode{"economy"} factorization is +returned. When the original matrix @var{A} has size MxN and M > N then the +@qcode{"economy"} factorization will calculate just N rows in @var{R} and N +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 the output @var{P} is always a vector +rather than a matrix. Background: The QR factorization has applications in the solution of least squares problems