Mercurial > octave-antonio
diff scripts/testfun/example.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 | 9fc020886ae9 |
children |
line wrap: on
line diff
--- a/scripts/testfun/example.m Sun May 03 15:36:23 2015 -0700 +++ b/scripts/testfun/example.m Sun May 03 17:00:11 2015 -0700 @@ -24,8 +24,9 @@ ## @deftypefnx {Function File} {[@var{s}, @var{idx}] =} example (@dots{}) ## ## Display the code for example @var{n} associated with the function -## @var{name}, but do not run it. If @var{n} is not specified, all examples -## are displayed. +## @var{name}, but do not run it. +## +## If @var{n} is not specified, all examples are displayed. ## ## When called with output arguments, the examples are returned in the form of ## a string @var{s}, with @var{idx} indicating the ending position of the