Mercurial > octave-antonio
diff scripts/testfun/demo.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 | 4197fc428c7d |
| children |
line wrap: on
line diff
--- a/scripts/testfun/demo.m Sun May 03 15:36:23 2015 -0700 +++ b/scripts/testfun/demo.m Sun May 03 17:00:11 2015 -0700 @@ -23,6 +23,7 @@ ## @deftypefnx {Function File} {} demo ("@var{name}", @var{n}) ## ## Run example code block @var{n} associated with the function @var{name}. +## ## If @var{n} is not specified, all examples are run. ## ## The preferred location for example code blocks is embedded within the script @@ -61,20 +62,19 @@ ## @end example ## ## @noindent -## between the sections, but this usage is discouraged. Other techniques -## to avoid multiple initialization blocks include using multiple plots -## with a new @code{figure} command between each plot, or using @code{subplot} -## to put multiple plots in the same window. +## between the sections, but this usage is discouraged. Other techniques to +## avoid multiple initialization blocks include using multiple plots with a new +## @code{figure} command between each plot, or using @code{subplot} to put +## multiple plots in the same window. ## -## Finally, because @code{demo} evaluates within a function context it is -## not possible to define new functions within the code. Anonymous functions -## make a good substitute in most instances. If function blocks -## @strong{must} be used then the code @code{eval (example ("function", n))} -## will allow Octave to see them. This has its own problems, however, as -## @code{eval} only evaluates one line or statement at a time. In this case -## the function declaration must be wrapped with -## @qcode{"if 1 <demo stuff> endif"} where @qcode{"if"} is on the same line -## as @qcode{"demo"}. For example: +## Finally, because @code{demo} evaluates within a function context it is not +## possible to define new functions within the code. Anonymous functions make +## a good substitute in most instances. If function blocks @strong{must} be +## used then the code @code{eval (example ("function", n))} will allow Octave +## to see them. This has its own problems, however, as @code{eval} only +## evaluates one line or statement at a time. In this case the function +## declaration must be wrapped with @qcode{"if 1 <demo stuff> endif"} where +## @qcode{"if"} is on the same line as @qcode{"demo"}. For example: ## ## @example ## @group