diff scripts/sparse/spaugment.m @ 20164:df437a52bcaf stable

doc: Update more docstrings to have one sentence summary as first line. Reviewed miscellaneous, sparse, strings in scripts directory. * scripts/miscellaneous/bzip2.m, scripts/miscellaneous/citation.m, scripts/miscellaneous/compare_versions.m, scripts/miscellaneous/computer.m, scripts/miscellaneous/debug.m, scripts/miscellaneous/dir.m, scripts/miscellaneous/edit.m, scripts/miscellaneous/error_ids.m, scripts/miscellaneous/fileattrib.m, scripts/miscellaneous/fullfile.m, scripts/miscellaneous/genvarname.m, scripts/miscellaneous/gzip.m, scripts/miscellaneous/mkoctfile.m, scripts/miscellaneous/news.m, scripts/miscellaneous/open.m, scripts/miscellaneous/parseparams.m, scripts/miscellaneous/recycle.m, scripts/miscellaneous/run.m, scripts/miscellaneous/swapbytes.m, scripts/miscellaneous/tar.m, scripts/miscellaneous/tmpnam.m, scripts/miscellaneous/unpack.m, scripts/miscellaneous/what.m, scripts/sparse/bicg.m, scripts/sparse/bicgstab.m, scripts/sparse/cgs.m, scripts/sparse/colperm.m, scripts/sparse/eigs.m, scripts/sparse/etreeplot.m, scripts/sparse/gmres.m, scripts/sparse/gplot.m, scripts/sparse/ichol.m, scripts/sparse/ilu.m, scripts/sparse/pcg.m, scripts/sparse/pcr.m, scripts/sparse/qmr.m, scripts/sparse/spaugment.m, scripts/sparse/spconvert.m, scripts/sparse/spdiags.m, scripts/sparse/spfun.m, scripts/sparse/spones.m, scripts/sparse/sprandsym.m, scripts/sparse/spstats.m, scripts/sparse/spy.m, scripts/sparse/svds.m, scripts/sparse/treelayout.m, scripts/sparse/treeplot.m, scripts/strings/base2dec.m, scripts/strings/bin2dec.m, scripts/strings/blanks.m, scripts/strings/cstrcat.m, scripts/strings/deblank.m, scripts/strings/dec2base.m, scripts/strings/dec2bin.m, scripts/strings/dec2hex.m, scripts/strings/findstr.m, scripts/strings/hex2dec.m, scripts/strings/index.m, scripts/strings/isletter.m, scripts/strings/isstrprop.m, scripts/strings/mat2str.m, scripts/strings/ostrsplit.m, scripts/strings/regexptranslate.m, scripts/strings/rindex.m, scripts/strings/str2num.m, scripts/strings/strcat.m, scripts/strings/strchr.m, scripts/strings/strjoin.m, scripts/strings/strjust.m, scripts/strings/strmatch.m, scripts/strings/strsplit.m, scripts/strings/strtok.m, scripts/strings/strtrim.m, scripts/strings/strtrunc.m, scripts/strings/substr.m, scripts/strings/untabify.m, scripts/time/datenum.m: Update more docstrings to have one sentence summary as first line.
author Rik <rik@octave.org>
date Mon, 04 May 2015 14:22:02 -0700
parents 9fc020886ae9
children
line wrap: on
line diff
--- a/scripts/sparse/spaugment.m	Sun May 03 21:52:42 2015 -0700
+++ b/scripts/sparse/spaugment.m	Mon May 04 14:22:02 2015 -0700
@@ -46,11 +46,11 @@
 ## @var{r} = @var{b} - @var{A} * @var{x}
 ## @end example
 ##
-## As the matrix @var{s} is symmetric indefinite it can be factorized
-## with @code{lu}, and the minimum norm solution can therefore be found
-## without the need for a @code{qr} factorization.  As the residual
-## error will be @code{zeros (@var{m}, @var{m})} for underdetermined
-## problems, and example can be
+## As the matrix @var{s} is symmetric indefinite it can be factorized with
+## @code{lu}, and the minimum norm solution can therefore be found without the
+## need for a @code{qr} factorization.  As the residual error will be
+## @code{zeros (@var{m}, @var{m})} for underdetermined problems, and example
+## can be
 ##
 ## @example
 ## @group
@@ -65,12 +65,12 @@
 ## @end group
 ## @end example
 ##
-## To find the solution of an overdetermined problem needs an estimate
-## of the residual error @var{r} and so it is more complex to formulate
-## a minimum norm solution using the @code{spaugment} function.
+## To find the solution of an overdetermined problem needs an estimate of the
+## residual error @var{r} and so it is more complex to formulate a minimum norm
+## solution using the @code{spaugment} function.
 ##
-## In general the left division operator is more stable and faster than
-## using the @code{spaugment} function.
+## In general the left division operator is more stable and faster than using
+## the @code{spaugment} function.
 ## @seealso{mldivide}
 ## @end deftypefn