Mercurial > hg > octave-lyh
changeset 15534:360adb4a3136
doc: Update docstring form rmfield() and add another %!test.
* libinterp/octave-value/ov-struct.cc(Frmfield): Update docstring.
Add a %! test for first form of calling function.
| author | Rik <rik@octave.org> |
|---|---|
| date | Tue, 16 Oct 2012 14:17:00 -0700 |
| parents | 7d76290fb29b |
| children | 94d21131fefd |
| files | libinterp/octave-value/ov-struct.cc |
| diffstat | 1 files changed, 10 insertions(+), 3 deletions(-) [+] |
line wrap: on
line diff
--- a/libinterp/octave-value/ov-struct.cc +++ b/libinterp/octave-value/ov-struct.cc @@ -2144,10 +2144,11 @@ DEFUN (rmfield, args, , "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {} rmfield (@var{s}, @var{f})\n\ +@deftypefn {Built-in Function} {@var{s} =} rmfield (@var{s}, \"@var{f}\")\n\ +@deftypefnx {Built-in Function} {@var{s} =} rmfield (@var{s}, @var{f})\n\ Return a copy of the structure (array) @var{s} with the field @var{f}\n\ removed. If @var{f} is a cell array of strings or a character array, remove\n\ -the named fields.\n\ +each of the named fields.\n\ @seealso{cellstr, iscellstr, setfield}\n\ @end deftypefn") { @@ -2192,8 +2193,14 @@ /* ## test rmfield +%!shared x +%! x(3).d=1; x(2).a=2; x(1).b=3; x(2).c=3; x(6).f="abc123"; +%! %!test -%! x(3).d=1; x(2).a=2; x(1).b=3; x(2).c=3; x(6).f="abc123"; +%! y = rmfield (x, "c"); +%! assert (fieldnames (y), {"d"; "a"; "b"; "f"}); +%! assert (size (y), [1, 6]); +%!test %! y = rmfield (x, {"a", "f"}); %! assert (fieldnames (y), {"d"; "b"; "c"}); %! assert (size (y), [1, 6]);