comparison scripts/testfun/fail.m @ 20162: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 64a2d4c87ecb
children
comparison
equal deleted inserted replaced
20160:03b9d17a2d95 20162:2645f9ef8c88
51 ## @end group 51 ## @end group
52 ## @end example 52 ## @end example
53 ## 53 ##
54 ## The angle brackets are not part of the output. 54 ## The angle brackets are not part of the output.
55 ## 55 ##
56 ## When called with the @qcode{"warning"} option @code{fail} will produce 56 ## When called with the @qcode{"warning"} option @code{fail} will produce an
57 ## an error if executing the code produces no warning. 57 ## error if executing the code produces no warning.
58 ## @seealso{assert, error} 58 ## @seealso{assert, error}
59 ## @end deftypefn 59 ## @end deftypefn
60 60
61 ## Author: Paul Kienzle <pkienzle@users.sf.net> 61 ## Author: Paul Kienzle <pkienzle@users.sf.net>
62 62