Mercurial > octave-nkf
diff scripts/testfun/assert.m @ 20197: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 | cbba639b956b |
| children | aa36fb998a4d |
line wrap: on
line diff
--- a/scripts/testfun/assert.m Sun May 03 15:36:23 2015 -0700 +++ b/scripts/testfun/assert.m Sun May 03 17:00:11 2015 -0700 @@ -33,27 +33,35 @@ ## @itemx assert (@var{cond}, @var{errmsg}) ## @itemx assert (@var{cond}, @var{errmsg}, @dots{}) ## @itemx assert (@var{cond}, @var{msg_id}, @var{errmsg}, @dots{}) -## Called with a single argument @var{cond}, @code{assert} produces an -## error if @var{cond} is false (numeric zero). Any additional arguments are -## passed to the @code{error} function for processing. +## Called with a single argument @var{cond}, @code{assert} produces an error if +## @var{cond} is false (numeric zero). +## +## Any additional arguments are passed to the @code{error} function for +## processing. ## ## @item assert (@var{observed}, @var{expected}) -## Produce an error if observed is not the same as expected. Note that -## @var{observed} and @var{expected} can be scalars, vectors, matrices, -## strings, cell arrays, or structures. +## Produce an error if observed is not the same as expected. +## +## Note that @var{observed} and @var{expected} can be scalars, vectors, +## matrices, strings, cell arrays, or structures. ## ## @item assert (@var{observed}, @var{expected}, @var{tol}) ## Produce an error if observed is not the same as expected but equality ## comparison for numeric data uses a tolerance @var{tol}. +## ## If @var{tol} is positive then it is an absolute tolerance which will produce ## an error if @code{abs (@var{observed} - @var{expected}) > abs (@var{tol})}. +## ## If @var{tol} is negative then it is a relative tolerance which will produce ## an error if @code{abs (@var{observed} - @var{expected}) > ## abs (@var{tol} * @var{expected})}. +## ## If @var{expected} is zero @var{tol} will always be interpreted as an -## absolute tolerance. If @var{tol} is not scalar its dimensions must agree -## with those of @var{observed} and @var{expected} and tests are performed on -## an element-by-element basis. +## absolute tolerance. +## +## If @var{tol} is not scalar its dimensions must agree with those of +## @var{observed} and @var{expected} and tests are performed on an +## element-by-element basis. ## @end table ## @seealso{fail, test, error, isequal} ## @end deftypefn