octave-antonio: scripts/testfun/example.m annotate

annotate scripts/testfun/example.m @ 19014:90a541a12c4b

example.m: Use ex_code, ex_idx for output variable names. * example.m: Use ex_code, ex_idx for output variable names.

author	Rik <rik@octave.org>
date	Sat, 16 Aug 2014 20:08:14 -0700
parents	d63878346099
children	26a770330953

rev	line source
17744 d63878346099 maint: Update copyright notices for release. John W. Eaton <jwe@octave.org> parents: 17281 diff changeset	1 ## Copyright (C) 2000-2013 Paul Kienzle
5589 f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	2 ##
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6494 diff changeset	3 ## This file is part of Octave.
5589 f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	4 ##
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6494 diff changeset	5 ## Octave is free software; you can redistribute it and/or modify it
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6494 diff changeset	6 ## under the terms of the GNU General Public License as published by
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6494 diff changeset	7 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6494 diff changeset	8 ## your option) any later version.
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6494 diff changeset	9 ##
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6494 diff changeset	10 ## Octave is distributed in the hope that it will be useful, but
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6494 diff changeset	11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6494 diff changeset	12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6494 diff changeset	13 ## General Public License for more details.
5589 f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	14 ##
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	15 ## You should have received a copy of the GNU General Public License
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6494 diff changeset	16 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6494 diff changeset	17 ## <http://www.gnu.org/licenses/>.
5589 f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	18
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	19 ## -- texinfo --
12643 55430618bd5f Properly warn when demo or example called on a function without demos Rik <octave@nomad.inbox5.com> parents: 12505 diff changeset	20 ## @deftypefn {Command} {} example @var{name}
55430618bd5f Properly warn when demo or example called on a function without demos Rik <octave@nomad.inbox5.com> parents: 12505 diff changeset	21 ## @deftypefnx {Command} {} example @var{name} @var{n}
14359 7277fe922e99 doc: Use Octave preference for double quote in docstrings in scripts/ Rik <octave@nomad.inbox5.com> parents: 14237 diff changeset	22 ## @deftypefnx {Function File} {} example ("@var{name}")
7277fe922e99 doc: Use Octave preference for double quote in docstrings in scripts/ Rik <octave@nomad.inbox5.com> parents: 14237 diff changeset	23 ## @deftypefnx {Function File} {} example ("@var{name}", @var{n})
12643 55430618bd5f Properly warn when demo or example called on a function without demos Rik <octave@nomad.inbox5.com> parents: 12505 diff changeset	24 ## @deftypefnx {Function File} {[@var{s}, @var{idx}] =} example (@dots{})
5589 f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	25 ##
12643 55430618bd5f Properly warn when demo or example called on a function without demos Rik <octave@nomad.inbox5.com> parents: 12505 diff changeset	26 ## Display the code for example @var{n} associated with the function
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 14868 diff changeset	27 ## @var{name}, but do not run it. If @var{n} is not specified, all examples
5589 f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	28 ## are displayed.
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	29 ##
12643 55430618bd5f Properly warn when demo or example called on a function without demos Rik <octave@nomad.inbox5.com> parents: 12505 diff changeset	30 ## When called with output arguments, the examples are returned in the form of
55430618bd5f Properly warn when demo or example called on a function without demos Rik <octave@nomad.inbox5.com> parents: 12505 diff changeset	31 ## a string @var{s}, with @var{idx} indicating the ending position of the
5589 f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	32 ## various examples.
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	33 ##
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	34 ## See @code{demo} for a complete explanation.
5642 2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe] jwe parents: 5589 diff changeset	35 ## @seealso{demo, test}
5589 f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	36 ## @end deftypefn
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	37
19014 90a541a12c4b example.m: Use ex_code, ex_idx for output variable names. Rik <rik@octave.org> parents: 17744 diff changeset	38 function [ex_code, ex_idx] = example (name, n = 0)
5589 f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	39
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	40 if (nargin < 1 \|\| nargin > 2)
6046 34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe] jwe parents: 5642 diff changeset	41 print_usage ();
5589 f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	42 endif
12505 6a1fe83fe129 Allow command forms of example and demo. Ben Abbott <bpabbott@mac.com> parents: 11587 diff changeset	43
19014 90a541a12c4b example.m: Use ex_code, ex_idx for output variable names. Rik <rik@octave.org> parents: 17744 diff changeset	44 if (ischar (n))
12505 6a1fe83fe129 Allow command forms of example and demo. Ben Abbott <bpabbott@mac.com> parents: 11587 diff changeset	45 n = str2double (n);
13141 e81ddf9cacd5 maint: untabify and remove trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 12643 diff changeset	46 endif
5589 f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	47
6494 76a1a953533d [project @ 2007-04-05 16:09:03 by jwe] jwe parents: 6046 diff changeset	48 [code, idx] = test (name, "grabdemo");
5589 f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	49 if (nargout > 0)
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	50 if (n > 0)
6494 76a1a953533d [project @ 2007-04-05 16:09:03 by jwe] jwe parents: 6046 diff changeset	51 if (n <= length (idx))
19014 90a541a12c4b example.m: Use ex_code, ex_idx for output variable names. Rik <rik@octave.org> parents: 17744 diff changeset	52 ex_code = code(idx(n):idx(n+1)-1);
90a541a12c4b example.m: Use ex_code, ex_idx for output variable names. Rik <rik@octave.org> parents: 17744 diff changeset	53 ex_idx = [1, length(ex_code)+1];
5589 f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	54 else
19014 90a541a12c4b example.m: Use ex_code, ex_idx for output variable names. Rik <rik@octave.org> parents: 17744 diff changeset	55 ex_code = "";
90a541a12c4b example.m: Use ex_code, ex_idx for output variable names. Rik <rik@octave.org> parents: 17744 diff changeset	56 ex_idx = [];
5589 f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	57 endif
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	58 else
19014 90a541a12c4b example.m: Use ex_code, ex_idx for output variable names. Rik <rik@octave.org> parents: 17744 diff changeset	59 ex_code = code;
90a541a12c4b example.m: Use ex_code, ex_idx for output variable names. Rik <rik@octave.org> parents: 17744 diff changeset	60 ex_idx = idx;
5589 f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	61 endif
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	62 else
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	63 if (n > 0)
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	64 doidx = n;
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	65 else
14868 5d3a684236b0 maint: Use Octave coding conventions for cuddling parentheses in scripts directory Rik <octave@nomad.inbox5.com> parents: 14363 diff changeset	66 doidx = 1:length (idx) - 1;
5589 f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	67 endif
12643 55430618bd5f Properly warn when demo or example called on a function without demos Rik <octave@nomad.inbox5.com> parents: 12505 diff changeset	68 if (isempty (idx))
55430618bd5f Properly warn when demo or example called on a function without demos Rik <octave@nomad.inbox5.com> parents: 12505 diff changeset	69 warning ("no example available for %s", name);
55430618bd5f Properly warn when demo or example called on a function without demos Rik <octave@nomad.inbox5.com> parents: 12505 diff changeset	70 return;
14868 5d3a684236b0 maint: Use Octave coding conventions for cuddling parentheses in scripts directory Rik <octave@nomad.inbox5.com> parents: 14363 diff changeset	71 elseif (n >= length (idx))
5d3a684236b0 maint: Use Octave coding conventions for cuddling parentheses in scripts directory Rik <octave@nomad.inbox5.com> parents: 14363 diff changeset	72 warning ("only %d examples available for %s", length (idx) - 1, name);
12643 55430618bd5f Properly warn when demo or example called on a function without demos Rik <octave@nomad.inbox5.com> parents: 12505 diff changeset	73 return;
5589 f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	74 endif
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	75
8507 cadc73247d65 style fixes John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	76 for i = 1:length (doidx)
12643 55430618bd5f Properly warn when demo or example called on a function without demos Rik <octave@nomad.inbox5.com> parents: 12505 diff changeset	77 block = code(idx(doidx(i)):idx(doidx(i)+1)-1);
6494 76a1a953533d [project @ 2007-04-05 16:09:03 by jwe] jwe parents: 6046 diff changeset	78 printf ("%s example %d:%s\n\n", name, doidx(i), block);
5589 f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	79 endfor
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	80 endif
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	81
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	82 endfunction
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	83
14039 e98140f84ae0 test: Rewrite %!tests to preserve warning state. Rik <octave@nomad.inbox5.com> parents: 13141 diff changeset	84
14237 11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	85 ## WARNING: don't modify the demos without modifying the tests!
5589 f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	86 %!demo
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14359 diff changeset	87 %! example ("example");
14237 11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	88
5589 f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	89 %!demo
14237 11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	90 %! clf;
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14359 diff changeset	91 %! t = 0:0.01:2*pi; x = sin (t);
12643 55430618bd5f Properly warn when demo or example called on a function without demos Rik <octave@nomad.inbox5.com> parents: 12505 diff changeset	92 %! plot (t,x)
5589 f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	93
19014 90a541a12c4b example.m: Use ex_code, ex_idx for output variable names. Rik <rik@octave.org> parents: 17744 diff changeset	94 %!assert (example ("example", 1), "\n example (\"example\");");
5589 f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	95 %!test
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14359 diff changeset	96 %! [code, idx] = example ("example");
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11563 diff changeset	97 %! assert (code, ...
19014 90a541a12c4b example.m: Use ex_code, ex_idx for output variable names. Rik <rik@octave.org> parents: 17744 diff changeset	98 %! "\n example (\"example\");\n clf;\n t = 0:0.01:2*pi; x = sin (t);\n plot (t,x)");
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14359 diff changeset	99 %! assert (idx, [1, 23, 73]);
5589 f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	100
12643 55430618bd5f Properly warn when demo or example called on a function without demos Rik <octave@nomad.inbox5.com> parents: 12505 diff changeset	101 %% Test input validation
14039 e98140f84ae0 test: Rewrite %!tests to preserve warning state. Rik <octave@nomad.inbox5.com> parents: 13141 diff changeset	102 %!error example
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14359 diff changeset	103 %!error example ("example", 3, 5)
14039 e98140f84ae0 test: Rewrite %!tests to preserve warning state. Rik <octave@nomad.inbox5.com> parents: 13141 diff changeset	104

Mercurial > octave-antonio

annotate scripts/testfun/example.m @ 19014:90a541a12c4b