Mercurial > hg > octave-terminal
changeset 14620:cd375519eab0
doc: Periodic grammar check of documentation
* get_unsatisfied_deps.m, print.m, shrinkfaces.m, polyfit.m, splinefit.m,
chol.cc, rand.cc, sparse.cc: Improve docstrings.
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Thu, 10 May 2012 22:08:18 -0700 |
parents | be12c85c6ce7 |
children | 1804d5422f61 |
files | scripts/pkg/private/get_unsatisfied_deps.m scripts/plot/print.m scripts/plot/shrinkfaces.m scripts/polynomial/polyfit.m scripts/polynomial/splinefit.m src/DLD-FUNCTIONS/chol.cc src/DLD-FUNCTIONS/rand.cc src/sparse.cc |
diffstat | 8 files changed, 27 insertions(+), 22 deletions(-) [+] |
line wrap: on
line diff
--- a/scripts/pkg/private/get_unsatisfied_deps.m +++ b/scripts/pkg/private/get_unsatisfied_deps.m @@ -18,7 +18,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{bad_deps} =} get_unsatisfied_deps (@var{desc},@var{installed_pkgs_lst}) +## @deftypefn {Function File} {@var{bad_deps} =} get_unsatisfied_deps (@var{desc}, @var{installed_pkgs_lst}) ## Undocumented internal function. ## @end deftypefn
--- a/scripts/plot/print.m +++ b/scripts/plot/print.m @@ -21,7 +21,7 @@ ## @deftypefnx {Function File} {} print (@var{options}) ## @deftypefnx {Function File} {} print (@var{filename}, @var{options}) ## @deftypefnx {Function File} {} print (@var{h}, @var{filename}, @var{options}) -## Print a graph, or save it to a file. Both output formatted for +## Print a graph, or save it to a file. Both output formatted for ## printing (PDF and PostScript), and many bitmapped and vector ## image formats are supported. ## @@ -35,8 +35,8 @@ ## ## For output to a printer, to a PostScript file, or a PDF file, ## the paper size is specified by the figure's @code{papersize} -## property. The location and size of the image on the page are -## specified by the figure's @code{paperposition} property. The +## property. The location and size of the image on the page are +## specified by the figure's @code{paperposition} property. The ## orientation of the page is specified by the figure's ## @code{paperorientation} property. ##
--- a/scripts/plot/shrinkfaces.m +++ b/scripts/plot/shrinkfaces.m @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} shrinkfaces (@var{p}, @var{sf}) +## @deftypefn {Function File} {} shrinkfaces (@var{p}, @var{sf}) ## @deftypefnx {Function File} {@var{nfv} =} shrinkfaces (@var{p}, @var{sf}) ## @deftypefnx {Function File} {@var{nfv} =} shrinkfaces (@var{fv}, @var{sf}) ## @deftypefnx {Function File} {@var{nfv} =} shrinkfaces (@var{f}, @var{v}, @var{sf}) @@ -40,7 +40,7 @@ ## Performing the shrinking on faces which are not convex can lead to ## undesired results. ## -## For example +## For example, ## ## @example ## @group
--- a/scripts/polynomial/polyfit.m +++ b/scripts/polynomial/polyfit.m @@ -22,7 +22,7 @@ ## @deftypefnx {Function File} {[@var{p}, @var{s}, @var{mu}] =} polyfit (@var{x}, @var{y}, @var{n}) ## Return the coefficients of a polynomial @var{p}(@var{x}) of degree ## @var{n} that minimizes the least-squares-error of the fit to the points -## @code{[@var{x}, @var{y}]}. If @var{n} is a logical vector, it is used +## @code{[@var{x}, @var{y}]}. If @var{n} is a logical vector, it is used ## as a mask to selectively force the corresponding polynomial ## coefficients to be used or ignored. ## @@ -53,7 +53,7 @@ ## @end table ## ## The second output may be used by @code{polyval} to calculate the -## statistical error limits of the predicted values. In particular, the +## statistical error limits of the predicted values. In particular, the ## standard deviation of @var{p} coefficients is given by @* ## @code{sqrt (diag (s.C)/s.df)*s.normr}. ##
--- a/scripts/polynomial/splinefit.m +++ b/scripts/polynomial/splinefit.m @@ -17,18 +17,18 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{pp} =} splinefit (@var{x}, @var{y}, @var{breaks}) -## Fits a piecewise cubic spline with breaks (knots) @var{breaks} to the +## @deftypefn {Function File} {@var{pp} =} splinefit (@var{x}, @var{y}, @var{breaks}) +## Fit a piecewise cubic spline with breaks (knots) @var{breaks} to the ## noisy data, @var{x} and @var{y}. @var{x} is a vector, and @var{y} -## a vector or ND array. If @var{y} is an ND array, then @var{x}(j) -## is matched to @var{y}(:,...,:,j). +## a vector or N-D array. If @var{y} is an N-D array, then @var{x}(j) +## is matched to @var{y}(:,@dots{},:,j). ## -## The fitted spline is returned as a piece-wise polynomial, @var{pp}, and +## The fitted spline is returned as a piecewise polynomial, @var{pp}, and ## may be evaluated using @code{ppval}. ## ## @deftypefnx {Function File} {@var{pp} =} splinefit (@var{x}, @var{y}, @var{p}) ## @var{p} is a positive integer defining the number of intervals along @var{x}, -## and @var{p}+1 is the number of breaks. The number of points in each interval +## and @var{p}+1 is the number of breaks. The number of points in each interval ## differ by no more than 1. ## ## @deftypefnx {Function File} {@var{pp} =} splinefit (@dots{}, "periodic", @var{periodic}) @@ -39,7 +39,7 @@ ## ## The optional property @var{periodic} is a logical value which specifies ## whether a periodic boundary condition is applied to the spline. The -## length of the period is @code{max(@var{breaks})-min(@var{breaks})}. +## length of the period is @code{max(@var{breaks})-min(@var{breaks})}. ## The default value is @code{false}. ## ## The optional property @var{robust} is a logical value which specifies @@ -65,12 +65,14 @@ ## @table @asis ## @item "xc" ## Vector of the x-locations of the constraints. +## ## @item "yc" ## Constaining values at the locations, @var{xc}. ## The default is an array of zeros. +## ## @item "cc" ## Coefficients (matrix). The default is an array of ones. The number of -## rows is limited to the order of the piece-wise polynomials, @var{order}. +## rows is limited to the order of the piecewise polynomials, @var{order}. ## @end table ## ## Constraints are linear combinations of derivatives of order 0 to
--- a/src/DLD-FUNCTIONS/chol.cc +++ b/src/DLD-FUNCTIONS/chol.cc @@ -129,9 +129,9 @@ \n\ @end ifnottex\n\ \n\ -For full matrices, if the \"lower\" flag is set only the lower triangular part\n\ -of the matrix is used for the factorization, otherwise the upper triangular\n\ -part is used.\n\ +For full matrices, if the \"lower\" flag is set only the lower triangular\n\ +part of the matrix is used for the factorization, otherwise the upper\n\ +triangular part is used.\n\ \n\ In general the lower triangular factorization is significantly faster for\n\ sparse matrices.\n\ @@ -623,6 +623,7 @@ Update or downdate a Cholesky@tie{}factorization. Given an upper triangular\n\ matrix @var{R} and a column vector @var{u}, attempt to determine another\n\ upper triangular matrix @var{R1} such that\n\ +\n\ @itemize @bullet\n\ @item\n\ @var{R1}'*@var{R1} = @var{R}'*@var{R} + @var{u}*@var{u}'\n\ @@ -634,6 +635,7 @@ @end itemize\n\ \n\ If @var{op} is \"-\", @var{info} is set to\n\ +\n\ @itemize\n\ @item 0 if the downdate was successful,\n\ \n\ @@ -833,6 +835,7 @@ @var{A1}, where @w{A1(p,p) = A}, @w{A1(:,j) = A1(j,:)' = u} and\n\ @w{p = [1:j-1,j+1:n+1]}. @w{u(j)} should be positive.\n\ On return, @var{info} is set to\n\ +\n\ @itemize\n\ @item 0 if the insertion was successful,\n\ \n\
--- a/src/DLD-FUNCTIONS/rand.cc +++ b/src/DLD-FUNCTIONS/rand.cc @@ -358,9 +358,9 @@ \n\ By default, the generator is initialized from @code{/dev/urandom} if it is\n\ available, otherwise from CPU time, wall clock time, and the current\n\ -fraction of a second. Note that this differs from @sc{Matlab}, which\n\ +fraction of a second. Note that this differs from @sc{matlab}, which\n\ always initializes the state to the same state at startup. To obtain\n\ -behavior comparable to @sc{Matlab}, initialize with a deterministic state\n\ +behavior comparable to @sc{matlab}, initialize with a deterministic state\n\ vector in Octave's startup files (@pxref{Startup Files}).\n\ \n\ To compute the pseudo-random sequence, @code{rand} uses the Mersenne\n\
--- a/src/sparse.cc +++ b/src/sparse.cc @@ -78,7 +78,7 @@ \n\ @strong{Note}: if multiple values are specified with the same\n\ @var{i}, @var{j} indices, the corresponding values in @var{s} will\n\ -be added. See @code{accumarray} for an example of how to produce different\n\ +be added. See @code{accumarray} for an example of how to produce different\n\ behavior, such as taking the minimum instead.\n\ \n\ The following are all equivalent:\n\