octave: scripts/legacy/isdir.m annotate

annotate scripts/legacy/isdir.m @ 29358:0a5b15007766 stable

update Octave Project Developers copyright for the new year In files that have the "Octave Project Developers" copyright notice, update for 2021.

author	John W. Eaton <jwe@octave.org>
date	Wed, 10 Feb 2021 09:52:15 -0500
parents	bd51beb6205e
children	7854d5752dd2

rev	line source
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	1 ########################################################################
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	2 ##
29358 0a5b15007766 update Octave Project Developers copyright for the new year John W. Eaton <jwe@octave.org> parents: 27923 diff changeset	3 ## Copyright (C) 2004-2021 The Octave Project Developers
27918 b442ec6dda5c use centralized file for copyright info for individual contributors John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	4 ##
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	5 ## See the file COPYRIGHT.md in the top-level directory of this
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	6 ## distribution or <https://octave.org/copyright/>.
5820 27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	7 ##
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	8 ## This file is part of Octave.
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	9 ##
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 24491 diff changeset	10 ## Octave is free software: you can redistribute it and/or modify it
5820 27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	11 ## under the terms of the GNU General Public License as published by
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 24491 diff changeset	12 ## the Free Software Foundation, either version 3 of the License, or
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22323 diff changeset	13 ## (at your option) any later version.
5820 27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	14 ##
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	15 ## Octave is distributed in the hope that it will be useful, but
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	16 ## WITHOUT ANY WARRANTY; without even the implied warranty of
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22323 diff changeset	17 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22323 diff changeset	18 ## GNU General Public License for more details.
5820 27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	19 ##
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	20 ## 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: 6861 diff changeset	21 ## along with Octave; see the file COPYING. If not, see
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 24491 diff changeset	22 ## <https://www.gnu.org/licenses/>.
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	23 ##
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	24 ########################################################################
5820 27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	25
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	26 ## -- texinfo --
20852 516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files. Rik <rik@octave.org> parents: 19697 diff changeset	27 ## @deftypefn {} {} isdir (@var{f})
25781 e04c56bbbace isdir.m: Make m-file a legacy function (bug #54489) Rik <rik@octave.org> parents: 25054 diff changeset	28 ##
e04c56bbbace isdir.m: Make m-file a legacy function (bug #54489) Rik <rik@octave.org> parents: 25054 diff changeset	29 ## This function is not recommended. Use @code{isfolder} or
e04c56bbbace isdir.m: Make m-file a legacy function (bug #54489) Rik <rik@octave.org> parents: 25054 diff changeset	30 ## @code{file_in_loadpath} instead.
e04c56bbbace isdir.m: Make m-file a legacy function (bug #54489) Rik <rik@octave.org> parents: 25054 diff changeset	31 ##
e04c56bbbace isdir.m: Make m-file a legacy function (bug #54489) Rik <rik@octave.org> parents: 25054 diff changeset	32 ## Return true if @var{f} is a directory and false otherwise.
e04c56bbbace isdir.m: Make m-file a legacy function (bug #54489) Rik <rik@octave.org> parents: 25054 diff changeset	33 ##
e04c56bbbace isdir.m: Make m-file a legacy function (bug #54489) Rik <rik@octave.org> parents: 25054 diff changeset	34 ## Compatibility Note: The @sc{matlab} function of the same name will also
e04c56bbbace isdir.m: Make m-file a legacy function (bug #54489) Rik <rik@octave.org> parents: 25054 diff changeset	35 ## search for @var{f} in the load path directories. To emulate this behavior
e04c56bbbace isdir.m: Make m-file a legacy function (bug #54489) Rik <rik@octave.org> parents: 25054 diff changeset	36 ## use
25828 8b548f2f8086 maint: Strip trailing whitespace from source files. John W. Eaton <jwe@octave.org> parents: 25781 diff changeset	37 ##
25781 e04c56bbbace isdir.m: Make m-file a legacy function (bug #54489) Rik <rik@octave.org> parents: 25054 diff changeset	38 ## @example
e04c56bbbace isdir.m: Make m-file a legacy function (bug #54489) Rik <rik@octave.org> parents: 25054 diff changeset	39 ## @var{tf} = ! isempty (file_in_loadpath (@var{f}))
e04c56bbbace isdir.m: Make m-file a legacy function (bug #54489) Rik <rik@octave.org> parents: 25054 diff changeset	40 ## @end example
e04c56bbbace isdir.m: Make m-file a legacy function (bug #54489) Rik <rik@octave.org> parents: 25054 diff changeset	41 ##
e04c56bbbace isdir.m: Make m-file a legacy function (bug #54489) Rik <rik@octave.org> parents: 25054 diff changeset	42 ## @seealso{isfolder, file_in_loadpath, exist, stat, is_absolute_filename, is_rooted_relative_filename}
5820 27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	43 ## @end deftypefn
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	44
11469 c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 11431 diff changeset	45 function retval = isdir (f)
21708 e316b1548d2d isdir.m: Don't call print_usage() with an argument. Rik <rik@octave.org> parents: 20852 diff changeset	46
25781 e04c56bbbace isdir.m: Make m-file a legacy function (bug #54489) Rik <rik@octave.org> parents: 25054 diff changeset	47 persistent warned = false;
e04c56bbbace isdir.m: Make m-file a legacy function (bug #54489) Rik <rik@octave.org> parents: 25054 diff changeset	48 if (! warned)
e04c56bbbace isdir.m: Make m-file a legacy function (bug #54489) Rik <rik@octave.org> parents: 25054 diff changeset	49 warned = true;
e04c56bbbace isdir.m: Make m-file a legacy function (bug #54489) Rik <rik@octave.org> parents: 25054 diff changeset	50 warning ("Octave:legacy-function",
e04c56bbbace isdir.m: Make m-file a legacy function (bug #54489) Rik <rik@octave.org> parents: 25054 diff changeset	51 "isdir is obsolete; use isfolder or dir_in_loadpath instead\n");
e04c56bbbace isdir.m: Make m-file a legacy function (bug #54489) Rik <rik@octave.org> parents: 25054 diff changeset	52 endif
e04c56bbbace isdir.m: Make m-file a legacy function (bug #54489) Rik <rik@octave.org> parents: 25054 diff changeset	53
12604 132c89bb44e3 maint: Refactor general/isXXX.m scripts to put input validation first. Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	54 if (nargin != 1)
21708 e316b1548d2d isdir.m: Don't call print_usage() with an argument. Rik <rik@octave.org> parents: 20852 diff changeset	55 print_usage ();
5820 27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	56 endif
12604 132c89bb44e3 maint: Refactor general/isXXX.m scripts to put input validation first. Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	57
132c89bb44e3 maint: Refactor general/isXXX.m scripts to put input validation first. Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	58 ## Exist returns an integer but isdir should return a logical.
132c89bb44e3 maint: Refactor general/isXXX.m scripts to put input validation first. Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	59 retval = (exist (f, "dir") == 7);
132c89bb44e3 maint: Refactor general/isXXX.m scripts to put input validation first. Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	60
5820 27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	61 endfunction
12795 9e7ebbaf69ff codesprint: new tests for files in scripts/general directory John W. Eaton <jwe@octave.org> parents: 12604 diff changeset	62
17338 1c89599167a6 maint: End m-files with 1 blank line. Rik <rik@octave.org> parents: 14363 diff changeset	63
25781 e04c56bbbace isdir.m: Make m-file a legacy function (bug #54489) Rik <rik@octave.org> parents: 25054 diff changeset	64 ## First test is necessary to provoke 1-time legacy warning
e04c56bbbace isdir.m: Make m-file a legacy function (bug #54489) Rik <rik@octave.org> parents: 25054 diff changeset	65 %!test
e04c56bbbace isdir.m: Make m-file a legacy function (bug #54489) Rik <rik@octave.org> parents: 25054 diff changeset	66 %! warning ("off", "Octave:legacy-function", "local");
e04c56bbbace isdir.m: Make m-file a legacy function (bug #54489) Rik <rik@octave.org> parents: 25054 diff changeset	67 %! isdir (pwd ());
e04c56bbbace isdir.m: Make m-file a legacy function (bug #54489) Rik <rik@octave.org> parents: 25054 diff changeset	68
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	69 %!assert (isdir (pwd ()))
25781 e04c56bbbace isdir.m: Make m-file a legacy function (bug #54489) Rik <rik@octave.org> parents: 25054 diff changeset	70 %!assert (! isdir (tempname ()))
12795 9e7ebbaf69ff codesprint: new tests for files in scripts/general directory John W. Eaton <jwe@octave.org> parents: 12604 diff changeset	71
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	72 %!error isdir ()
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	73 %!error isdir (1, 2)

Mercurial > octave

annotate scripts/legacy/isdir.m @ 29358:0a5b15007766 stable