Mercurial > hg > octave-nkf
diff scripts/special-matrix/gallery.m @ 20372:2645f9ef8c88 stable
doc: Update more docstrings to have one sentence summary as first line.
Reviewed specfun, special-matrix, testfun, and time script directories.
* scripts/specfun/expint.m, scripts/specfun/isprime.m,
scripts/specfun/legendre.m, scripts/specfun/primes.m,
scripts/specfun/reallog.m, scripts/specfun/realsqrt.m,
scripts/special-matrix/gallery.m, scripts/special-matrix/hadamard.m,
scripts/special-matrix/hankel.m, scripts/special-matrix/hilb.m,
scripts/special-matrix/invhilb.m, scripts/special-matrix/magic.m,
scripts/special-matrix/pascal.m, scripts/special-matrix/rosser.m,
scripts/special-matrix/toeplitz.m, scripts/special-matrix/vander.m,
scripts/special-matrix/wilkinson.m, scripts/testfun/assert.m,
scripts/testfun/demo.m, scripts/testfun/example.m, scripts/testfun/fail.m,
scripts/testfun/rundemos.m, scripts/testfun/runtests.m,
scripts/testfun/speed.m, scripts/time/asctime.m, scripts/time/calendar.m,
scripts/time/clock.m, scripts/time/ctime.m, scripts/time/datenum.m,
scripts/time/datestr.m, scripts/time/datevec.m, scripts/time/etime.m,
scripts/time/is_leap_year.m, scripts/time/now.m, scripts/time/weekday.m:
Update more docstrings to have one sentence summary as first line.
| author | Rik <rik@octave.org> |
|---|---|
| date | Sun, 03 May 2015 17:00:11 -0700 |
| parents | 941e782d0429 |
| children | 83792dd9bcc1 |
line wrap: on
line diff
--- a/scripts/special-matrix/gallery.m +++ b/scripts/special-matrix/gallery.m @@ -157,9 +157,9 @@ ## The second input is a matrix of dimensions describing the size of the output. ## The dimensions can also be input as comma-separated arguments. ## -## The input @var{j} is an integer index in the range [0, 2^32-1]. The -## values of the output matrix are always exactly the same -## (reproducibility) for a given size input and @var{j} index. +## The input @var{j} is an integer index in the range [0, 2^32-1]. The values +## of the output matrix are always exactly the same (reproducibility) for a +## given size input and @var{j} index. ## ## The final optional argument determines the class of the resulting matrix. ## Possible values for @var{class}: @qcode{"uint8"}, @qcode{"uint16"}, @@ -181,7 +181,7 @@ ## ## @deftypefn {Function File} {@var{a} =} gallery ("ipjfact", @var{n}) ## @deftypefnx {Function File} {@var{a} =} gallery ("ipjfact", @var{n}, @var{k}) -## Create an Hankel matrix with factorial elements. +## Create a Hankel matrix with factorial elements. ## ## @end deftypefn ## @@ -257,9 +257,9 @@ ## The first input is a matrix of dimensions describing the size of the output. ## The dimensions can also be input as comma-separated arguments. ## -## The input @var{j} is an integer index in the range [0, 2^32-1]. The -## values of the output matrix are always exactly the same -## (reproducibility) for a given size input and @var{j} index. +## The input @var{j} is an integer index in the range [0, 2^32-1]. The values +## of the output matrix are always exactly the same (reproducibility) for a +## given size input and @var{j} index. ## ## The final optional argument determines the class of the resulting matrix. ## Possible values for @var{class}: @qcode{"single"}, @qcode{"double"}. @@ -380,9 +380,9 @@ ## The first input is a matrix of dimensions describing the size of the output. ## The dimensions can also be input as comma-separated arguments. ## -## The input @var{j} is an integer index in the range [0, 2^32-1]. The -## values of the output matrix are always exactly the same -## (reproducibility) for a given size input and @var{j} index. +## The input @var{j} is an integer index in the range [0, 2^32-1]. The values +## of the output matrix are always exactly the same (reproducibility) for a +## given size input and @var{j} index. ## ## The final optional argument determines the class of the resulting matrix. ## Possible values for @var{class}: @qcode{"single"}, @qcode{"double"}.