Mercurial > octave-nkf
changeset 19057:ffba4ffa1f85
demo.m: Overhaul function.
* demo.m: Rewrite docstring. Improve input validation.
Add more %!error tests.
author | Rik <rik@octave.org> |
---|---|
date | Sun, 17 Aug 2014 11:43:12 -0700 |
parents | cf24eef5051d |
children | 26a770330953 |
files | scripts/testfun/demo.m |
diffstat | 1 files changed, 51 insertions(+), 37 deletions(-) [+] |
line wrap: on
line diff
--- a/scripts/testfun/demo.m Sat Aug 16 23:15:56 2014 -0700 +++ b/scripts/testfun/demo.m Sun Aug 17 11:43:12 2014 -0700 @@ -25,12 +25,14 @@ ## Run example code block @var{n} associated with the function @var{name}. ## If @var{n} is not specified, all examples are run. ## -## Examples are stored in the script file, or in a file with the same -## name but no extension located on Octave's load path. To keep examples -## separate from regular script code, all lines are prefixed by @code{%!}. Each -## example must also be introduced by the keyword @qcode{"demo"} flush left -## to the prefix with no intervening spaces. The remainder of the example -## can contain arbitrary Octave code. For example: +## The preferred location for example code blocks is embedded within the script +## m-file immediately following the code that it exercises. Alternatively, +## the examples may be stored in a file with the same name but no extension +## located on Octave's load path. To separate examples from regular script +## code all lines are prefixed by @code{%!}. Each example must also be +## introduced by the keyword @qcode{"demo"} flush left to the prefix with no +## intervening spaces. The remainder of the example can contain arbitrary +## Octave code. For example: ## ## @example ## @group @@ -38,78 +40,84 @@ ## %! t = 0:0.01:2*pi; ## %! x = sin (t); ## %! plot (t, x); -## %! %------------------------------------------------- -## %! % the figure window shows one cycle of a sine wave +## %! title ("one cycle of a sine wave"); +## %! #------------------------------------------------- +## %! # the figure window shows one cycle of a sine wave ## @end group ## @end example ## -## Note that the code is displayed before it is executed, so a simple -## comment at the end suffices for labeling what is being shown. It is -## generally not necessary to use @code{disp} or @code{printf} within the demo. +## Note that the code is displayed before it is executed so that a simple +## comment at the end suffices for labeling what is being shown. For plots, +## labeling can also be done with @code{title} or @code{text}. It is generally +## @strong{not} necessary to use @code{disp} or @code{printf} within the demo. ## -## Demos are run in a function environment with no access to external -## variables. This means that every demo must have separate initialization -## code. Alternatively, all demos can be combined into a single large demo -## with the code +## Demos are run in a stand-alone function environment with no access to +## external variables. This means that every demo must have separate +## initialization code. Alternatively, all demos can be combined into a single +## large demo with the code ## ## @example -## %! input("Press <enter> to continue: ","s"); +## %! input ("Press <enter> to continue: ", "s"); ## @end example ## ## @noindent -## between the sections, but this is discouraged. Other techniques +## 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. ## -## Also, because demo evaluates within a function context, you cannot -## define new functions inside a demo. If you must have function blocks, -## rather than just anonymous functions or inline functions, you will have to -## use @code{eval (example ("function",n))} to see them. Because eval only -## evaluates one line, or one statement if the statement crosses -## multiple lines, you must wrap your demo in @qcode{"if 1 <demo stuff> endif"} -## with the @qcode{"if"} 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 ## %!demo if 1 -## %! function y=f(x) -## %! y=x; +## %! function y = f(x) +## %! y = x; ## %! endfunction ## %! f(3) ## %! endif ## @end group ## @end example ## -## @seealso{test, example} +## @seealso{rundemos, example, test} ## @end deftypefn ## FIXME: modify subplot so that gnuplot_has_multiplot == 0 causes it to ## use the current figure window but pause if not plotting in the ## first subplot. -function demo (name, n) +function demo (name, n = 0) if (nargin < 1 || nargin > 2) print_usage (); endif - if (nargin < 2) - n = 0; - elseif (ischar (n)) + if (ischar (n)) n = str2double (n); endif + if (! (isreal (n) && isscalar (n) && n == fix (n))) + error ("demo: N must be a scalar integer"); + endif + [code, idx] = test (name, "grabdemo"); if (idx == -1) - warning ("no function %s found", name); + warning ("demo: no function %s found", name); return; elseif (isempty (idx)) - warning ("no demo available for %s", name); + warning ("demo: no demo available for %s", name); return; elseif (n >= length (idx)) - warning ("only %d demos available for %s", length (idx) - 1, name); + warning ("demo: only %d demos available for %s", length (idx) - 1, name); return; endif @@ -128,7 +136,7 @@ try block = code(idx(doidx(i)):idx(doidx(i)+1)-1); ## Use an environment without variables - eval (["function __demo__()\n" block "\nendfunction"]); + eval (["function __demo__ ()\n" block "\nendfunction"]); ## Display the code that will be executed before executing it printf ("%s example %d:%s\n\n", name, doidx(i), block); __demo__; @@ -146,9 +154,15 @@ %! t = 0:0.01:2*pi; %! x = sin (t); %! plot (t, x); -%! %------------------------------------------------- -%! % the figure window shows one cycle of a sine wave +%! title ("one cycle of a sine wave"); +%! #------------------------------------------------- +%! # the figure window shows one cycle of a sine wave %!error demo () %!error demo (1, 2, 3) +%!error <N must be a scalar integer> demo ("demo", {1}) +%!error <N must be a scalar integer> demo ("demo", ones (2,2)) +%!error <N must be a scalar integer> demo ("demo", 1.5) +%!warning <no function .* found> demo ("_%NOT_A_FUNCTION%_"); +%!warning <only 1 demos available for demo> demo ("demo", 10);