octave: scripts/help/warning

annotate scripts/help/warning_ids.m @ 32058:e242124f1240

Overhaul input validation of sparse() function. * sparse.cc (Fsparse): Decode input type and identify floating point inputs. If input is of single type, emit new warning "Octave:sparse:double-conversion". If input is neither floating point or logical, then call err_wrong_type_arg() for pretty error message. Rename temporary variable 'k' to "argidx" for clarity. New temporary variable "arg" to increase readability of code. Add FIXME note about unreachable code due to behavior of get_dimensions(). * sparse.cc (Fissparse): Turn off warning about double-conversion temporarily for test which has single input. * warning_ids.m: Add description for new warning ID "Octave:sparse:double-conversion". * mk-sparse-tst.sh: Redo BIST tests for sparse() construction.

author	Rik <rik@octave.org>
date	Wed, 26 Apr 2023 10:09:09 -0700
parents	597f3ee61a48
children	2e484f9f1f18

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 ##
31706 597f3ee61a48 update Octave Project Developers copyright for the new year John W. Eaton <jwe@octave.org> parents: 31593 diff changeset	3 ## Copyright (C) 2006-2023 The Octave Project Developers
27918 b442ec6dda5c use centralized file for copyright info for individual contributors John W. Eaton <jwe@octave.org> parents: 27517 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/>.
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6555 diff changeset	7 ##
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6555 diff changeset	8 ## This file is part of Octave.
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6555 diff changeset	9 ##
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 24473 diff changeset	10 ## Octave is free software: you can redistribute it and/or modify it
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6555 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: 24473 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.
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6555 diff changeset	14 ##
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6555 diff changeset	15 ## Octave is distributed in the hope that it will be useful, but
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6555 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.
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6555 diff changeset	19 ##
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6555 diff changeset	20 ## You should have received a copy of the GNU General Public License
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6555 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: 24473 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 ########################################################################
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6555 diff changeset	25
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	26 ## -- texinfo --
14119 94e2a76f1e5a doc: Final grammarcheck and spellcheck before 3.6.0 release. Rik <octave@nomad.inbox5.com> parents: 14116 diff changeset	27 ## @cindex warning ids
14366 b76f0740940e doc: Periodic grammar check of documentation. Rik <octave@nomad.inbox5.com> parents: 14363 diff changeset	28 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	29 ## @table @code
13842 4aadd3e2c5bc warning_ids.m: Add missing warnings to list. They are not documented. Rik <octave@nomad.inbox5.com> parents: 13841 diff changeset	30 ## @item Octave:abbreviated-property-match
30353 212461a26e9c doc: grammarcheck m-files in scripts/ directory ahead of 7.1 release. Rik <rik@octave.org> parents: 30315 diff changeset	31 ## If the @code{Octave:abbreviated-property-match} warning is enabled, a
212461a26e9c doc: grammarcheck m-files in scripts/ directory ahead of 7.1 release. Rik <rik@octave.org> parents: 30315 diff changeset	32 ## warning is printed if a non-exact or ambiguous match is being used for a
212461a26e9c doc: grammarcheck m-files in scripts/ directory ahead of 7.1 release. Rik <rik@octave.org> parents: 30315 diff changeset	33 ## operation specifying an object property. For example, for a graphics
212461a26e9c doc: grammarcheck m-files in scripts/ directory ahead of 7.1 release. Rik <rik@octave.org> parents: 30315 diff changeset	34 ## object, @var{fig}, with the property @qcode{'displayname'},
30315 8a80c89b021e warning_ids.m: fill in missing warning descriptions (bug #39434) Nicholas R. Jankowski <jankowskin@asme.org> parents: 29359 diff changeset	35 ## @code{get (@var{fig}, 'dis')} elicits a warning if the
8a80c89b021e warning_ids.m: fill in missing warning descriptions (bug #39434) Nicholas R. Jankowski <jankowskin@asme.org> parents: 29359 diff changeset	36 ## @code{Octave:abbreviated-property-match} warning is enabled.
13842 4aadd3e2c5bc warning_ids.m: Add missing warnings to list. They are not documented. Rik <octave@nomad.inbox5.com> parents: 13841 diff changeset	37 ## By default, the @code{Octave:abbreviated-property-match} warning is enabled.
4aadd3e2c5bc warning_ids.m: Add missing warnings to list. They are not documented. Rik <octave@nomad.inbox5.com> parents: 13841 diff changeset	38 ##
23994 8785b3717140 Issue a warning if addpath() called for a +pkg directory (bug #45410). Rik <rik@octave.org> parents: 23918 diff changeset	39 ## @item Octave:addpath-pkg
8785b3717140 Issue a warning if addpath() called for a +pkg directory (bug #45410). Rik <rik@octave.org> parents: 23918 diff changeset	40 ## If the @code{Octave:addpath-pkg} warning is enabled,
8785b3717140 Issue a warning if addpath() called for a +pkg directory (bug #45410). Rik <rik@octave.org> parents: 23918 diff changeset	41 ## Octave will warn when a package directory (i.e., +package_name) is added
8785b3717140 Issue a warning if addpath() called for a +pkg directory (bug #45410). Rik <rik@octave.org> parents: 23918 diff changeset	42 ## to the @code{path}. Typically, only the parent directory which contains the
8785b3717140 Issue a warning if addpath() called for a +pkg directory (bug #45410). Rik <rik@octave.org> parents: 23918 diff changeset	43 ## package directory should be added to the load path.
8785b3717140 Issue a warning if addpath() called for a +pkg directory (bug #45410). Rik <rik@octave.org> parents: 23918 diff changeset	44 ## By default, the @code{Octave:addpath-pkg} warning is enabled.
8785b3717140 Issue a warning if addpath() called for a +pkg directory (bug #45410). Rik <rik@octave.org> parents: 23918 diff changeset	45 ##
21990 efce657ceb86 Provide a warning when an array is used in an if/while/until (bug #43098). Lachlan Andrew <lachlanbis@gmail.com> parents: 21695 diff changeset	46 ## @item Octave:array-as-logical
21993 a937963aacc9 * warning_ids.m: Doc fix for array-as-logical. John W. Eaton <jwe@octave.org> parents: 21990 diff changeset	47 ## If the @code{Octave:array-as-logical} warning is enabled,
21990 efce657ceb86 Provide a warning when an array is used in an if/while/until (bug #43098). Lachlan Andrew <lachlanbis@gmail.com> parents: 21695 diff changeset	48 ## Octave will warn when an array of size greater than 1x1 is used
27062 ffdfeb835aef warning_ids.m: Add docstring for new "Octave:empty-index" ID (bug #56167). Rik <rik@octave.org> parents: 26935 diff changeset	49 ## as a truth value in an if, while, or until statement.
21990 efce657ceb86 Provide a warning when an array is used in an if/while/until (bug #43098). Lachlan Andrew <lachlanbis@gmail.com> parents: 21695 diff changeset	50 ## By default, the @code{Octave:array-as-logical} warning is disabled.
efce657ceb86 Provide a warning when an array is used in an if/while/until (bug #43098). Lachlan Andrew <lachlanbis@gmail.com> parents: 21695 diff changeset	51 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	52 ## @item Octave:array-to-scalar
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	53 ## If the @code{Octave:array-to-scalar} warning is enabled, Octave will
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	54 ## warn when an implicit conversion from an array to a scalar value is
13841 0a158dbdb04a Remove 3 unused warning ids Rik <octave@nomad.inbox5.com> parents: 12845 diff changeset	55 ## attempted.
0a158dbdb04a Remove 3 unused warning ids Rik <octave@nomad.inbox5.com> parents: 12845 diff changeset	56 ## By default, the @code{Octave:array-to-scalar} warning is disabled.
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	57 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	58 ## @item Octave:array-to-vector
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	59 ## If the @code{Octave:array-to-vector} warning is enabled, Octave will
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	60 ## warn when an implicit conversion from an array to a vector value is
13841 0a158dbdb04a Remove 3 unused warning ids Rik <octave@nomad.inbox5.com> parents: 12845 diff changeset	61 ## attempted.
0a158dbdb04a Remove 3 unused warning ids Rik <octave@nomad.inbox5.com> parents: 12845 diff changeset	62 ## By default, the @code{Octave:array-to-vector} warning is disabled.
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	63 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	64 ## @item Octave:assign-as-truth-value
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	65 ## If the @code{Octave:assign-as-truth-value} warning is
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	66 ## enabled, a warning is issued for statements like
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	67 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	68 ## @example
9051 1bf0ce0930be Grammar check TexInfo in all .m files Rik <rdrider0-list@yahoo.com> parents: 9039 diff changeset	69 ## @group
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	70 ## if (s = t)
9039 51dc9691f23f Cleanup documentation files errors.texi, debug.texi, io.texi Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	71 ## @dots{}
9051 1bf0ce0930be Grammar check TexInfo in all .m files Rik <rdrider0-list@yahoo.com> parents: 9039 diff changeset	72 ## @end group
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	73 ## @end example
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	74 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	75 ## @noindent
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	76 ## since such statements are not common, and it is likely that the intent
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	77 ## was to write
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	78 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	79 ## @example
9051 1bf0ce0930be Grammar check TexInfo in all .m files Rik <rdrider0-list@yahoo.com> parents: 9039 diff changeset	80 ## @group
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	81 ## if (s == t)
9039 51dc9691f23f Cleanup documentation files errors.texi, debug.texi, io.texi Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	82 ## @dots{}
9051 1bf0ce0930be Grammar check TexInfo in all .m files Rik <rdrider0-list@yahoo.com> parents: 9039 diff changeset	83 ## @end group
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	84 ## @end example
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	85 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	86 ## @noindent
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	87 ## instead.
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	88 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	89 ## There are times when it is useful to write code that contains
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	90 ## assignments within the condition of a @code{while} or @code{if}
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	91 ## statement. For example, statements like
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	92 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	93 ## @example
9051 1bf0ce0930be Grammar check TexInfo in all .m files Rik <rdrider0-list@yahoo.com> parents: 9039 diff changeset	94 ## @group
14327 4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	95 ## while (c = getc ())
9039 51dc9691f23f Cleanup documentation files errors.texi, debug.texi, io.texi Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	96 ## @dots{}
9051 1bf0ce0930be Grammar check TexInfo in all .m files Rik <rdrider0-list@yahoo.com> parents: 9039 diff changeset	97 ## @end group
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	98 ## @end example
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	99 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	100 ## @noindent
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	101 ## are common in C programming.
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	102 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	103 ## It is possible to avoid all warnings about such statements by
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	104 ## disabling the @code{Octave:assign-as-truth-value} warning,
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	105 ## but that may also let real errors like
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	106 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	107 ## @example
9051 1bf0ce0930be Grammar check TexInfo in all .m files Rik <rdrider0-list@yahoo.com> parents: 9039 diff changeset	108 ## @group
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	109 ## if (x = 1) # intended to test (x == 1)!
9039 51dc9691f23f Cleanup documentation files errors.texi, debug.texi, io.texi Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	110 ## @dots{}
9051 1bf0ce0930be Grammar check TexInfo in all .m files Rik <rdrider0-list@yahoo.com> parents: 9039 diff changeset	111 ## @end group
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	112 ## @end example
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	113 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	114 ## @noindent
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	115 ## slip by.
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	116 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	117 ## In such cases, it is possible suppress errors for specific statements by
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	118 ## writing them with an extra set of parentheses. For example, writing the
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	119 ## previous example as
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	120 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	121 ## @example
9051 1bf0ce0930be Grammar check TexInfo in all .m files Rik <rdrider0-list@yahoo.com> parents: 9039 diff changeset	122 ## @group
14327 4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	123 ## while ((c = getc ()))
9039 51dc9691f23f Cleanup documentation files errors.texi, debug.texi, io.texi Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	124 ## @dots{}
9051 1bf0ce0930be Grammar check TexInfo in all .m files Rik <rdrider0-list@yahoo.com> parents: 9039 diff changeset	125 ## @end group
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	126 ## @end example
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	127 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	128 ## @noindent
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	129 ## will prevent the warning from being printed for this statement, while
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	130 ## allowing Octave to warn about other assignments used in conditional
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	131 ## contexts.
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	132 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	133 ## By default, the @code{Octave:assign-as-truth-value} warning is enabled.
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	134 ##
12486 32279948bf3b Document the Octave:autoload-relative-file-name warning. Thomas Weber <tweber@debian.org> parents: 12477 diff changeset	135 ## @item Octave:autoload-relative-file-name
32279948bf3b Document the Octave:autoload-relative-file-name warning. Thomas Weber <tweber@debian.org> parents: 12477 diff changeset	136 ## If the @code{Octave:autoload-relative-file-name} is enabled,
32279948bf3b Document the Octave:autoload-relative-file-name warning. Thomas Weber <tweber@debian.org> parents: 12477 diff changeset	137 ## Octave will warn when parsing autoload() function calls with relative
12575 d0b799dafede Grammarcheck files for 3.4.1 release. Rik <octave@nomad.inbox5.com> parents: 12486 diff changeset	138 ## paths to function files. This usually happens when using autoload()
12486 32279948bf3b Document the Octave:autoload-relative-file-name warning. Thomas Weber <tweber@debian.org> parents: 12477 diff changeset	139 ## calls in PKG_ADD files, when the PKG_ADD file is not in the same
32279948bf3b Document the Octave:autoload-relative-file-name warning. Thomas Weber <tweber@debian.org> parents: 12477 diff changeset	140 ## directory as the .oct file referred to by the autoload() command.
21546 f7f97d7e9294 doc: Wrap m-file docstrings to 79 characters + newline (80 total). Rik <rik@octave.org> parents: 20913 diff changeset	141 ## By default, the @code{Octave:autoload-relative-file-name} warning is
f7f97d7e9294 doc: Wrap m-file docstrings to 79 characters + newline (80 total). Rik <rik@octave.org> parents: 20913 diff changeset	142 ## enabled.
12486 32279948bf3b Document the Octave:autoload-relative-file-name warning. Thomas Weber <tweber@debian.org> parents: 12477 diff changeset	143 ##
28732 f9201e7cbe00 Add warning when multi-row char matrix is converted to string (bug #49536) Rik <rik@octave.org> parents: 28593 diff changeset	144 ## @item Octave:charmat-truncated
f9201e7cbe00 Add warning when multi-row char matrix is converted to string (bug #49536) Rik <rik@octave.org> parents: 28593 diff changeset	145 ## If the @code{Octave:charmat-truncated} warning is enabled, a warning is
f9201e7cbe00 Add warning when multi-row char matrix is converted to string (bug #49536) Rik <rik@octave.org> parents: 28593 diff changeset	146 ## printed when a character matrix with multiple rows is converted to a string.
f9201e7cbe00 Add warning when multi-row char matrix is converted to string (bug #49536) Rik <rik@octave.org> parents: 28593 diff changeset	147 ## In this case, the Octave interpreter keeps only the first row and discards
f9201e7cbe00 Add warning when multi-row char matrix is converted to string (bug #49536) Rik <rik@octave.org> parents: 28593 diff changeset	148 ## the others.
f9201e7cbe00 Add warning when multi-row char matrix is converted to string (bug #49536) Rik <rik@octave.org> parents: 28593 diff changeset	149 ## By default, the @code{Octave:charmat-truncated} warning is enabled.
f9201e7cbe00 Add warning when multi-row char matrix is converted to string (bug #49536) Rik <rik@octave.org> parents: 28593 diff changeset	150 ##
28479 5fb8449e4dd0 warning_ids.m: Document "Octave:classdef-to-struct" ID. Rik <rik@octave.org> parents: 28279 diff changeset	151 ## @item Octave:classdef-to-struct
5fb8449e4dd0 warning_ids.m: Document "Octave:classdef-to-struct" ID. Rik <rik@octave.org> parents: 28279 diff changeset	152 ## If the @code{Octave:classdef-to-struct} warning is enabled, a warning
5fb8449e4dd0 warning_ids.m: Document "Octave:classdef-to-struct" ID. Rik <rik@octave.org> parents: 28279 diff changeset	153 ## is issued when a classdef object is forcibly converted into a struct with
5fb8449e4dd0 warning_ids.m: Document "Octave:classdef-to-struct" ID. Rik <rik@octave.org> parents: 28279 diff changeset	154 ## @code{struct (@var{CLASSDEF_OBJ})}. Conversion removes the access
5fb8449e4dd0 warning_ids.m: Document "Octave:classdef-to-struct" ID. Rik <rik@octave.org> parents: 28279 diff changeset	155 ## restrictions from the object and makes private and protected properties
5fb8449e4dd0 warning_ids.m: Document "Octave:classdef-to-struct" ID. Rik <rik@octave.org> parents: 28279 diff changeset	156 ## visible.
5fb8449e4dd0 warning_ids.m: Document "Octave:classdef-to-struct" ID. Rik <rik@octave.org> parents: 28279 diff changeset	157 ## By default, the @code{Octave:classdef-to-struct} warning is enabled.
5fb8449e4dd0 warning_ids.m: Document "Octave:classdef-to-struct" ID. Rik <rik@octave.org> parents: 28279 diff changeset	158 ##
27517 85ad4689aa05 Add warning when non-scalar argument presented to ':' range operator. Rik <rik@octave.org> parents: 27066 diff changeset	159 ## @item Octave:colon-complex-argument
85ad4689aa05 Add warning when non-scalar argument presented to ':' range operator. Rik <rik@octave.org> parents: 27066 diff changeset	160 ## If the @code{Octave:colon-complex-argument} warning is enabled, a warning
85ad4689aa05 Add warning when non-scalar argument presented to ':' range operator. Rik <rik@octave.org> parents: 27066 diff changeset	161 ## is issued when one of the three arguments to the colon operator (base,
85ad4689aa05 Add warning when non-scalar argument presented to ':' range operator. Rik <rik@octave.org> parents: 27066 diff changeset	162 ## increment, limit) is a complex value. For example, @code{1:3*i} will
85ad4689aa05 Add warning when non-scalar argument presented to ':' range operator. Rik <rik@octave.org> parents: 27066 diff changeset	163 ## cause a warning to be emitted.
85ad4689aa05 Add warning when non-scalar argument presented to ':' range operator. Rik <rik@octave.org> parents: 27066 diff changeset	164 ## By default, the @code{Octave:colon-complex-argument} warning is enabled.
85ad4689aa05 Add warning when non-scalar argument presented to ':' range operator. Rik <rik@octave.org> parents: 27066 diff changeset	165 ##
85ad4689aa05 Add warning when non-scalar argument presented to ':' range operator. Rik <rik@octave.org> parents: 27066 diff changeset	166 ## @item Octave:colon-nonscalar-argument
85ad4689aa05 Add warning when non-scalar argument presented to ':' range operator. Rik <rik@octave.org> parents: 27066 diff changeset	167 ## If the @code{Octave:colon-nonscalar-argument} warning is enabled, a warning
85ad4689aa05 Add warning when non-scalar argument presented to ':' range operator. Rik <rik@octave.org> parents: 27066 diff changeset	168 ## is issued when one of the three arguments to the colon operator (base,
85ad4689aa05 Add warning when non-scalar argument presented to ':' range operator. Rik <rik@octave.org> parents: 27066 diff changeset	169 ## increment, limit) is not a scalar. For example, @code{1:[3, 5]} will
85ad4689aa05 Add warning when non-scalar argument presented to ':' range operator. Rik <rik@octave.org> parents: 27066 diff changeset	170 ## cause a warning to be emitted.
85ad4689aa05 Add warning when non-scalar argument presented to ':' range operator. Rik <rik@octave.org> parents: 27066 diff changeset	171 ## By default, the @code{Octave:colon-nonscalar-argument} warning is enabled.
85ad4689aa05 Add warning when non-scalar argument presented to ':' range operator. Rik <rik@octave.org> parents: 27066 diff changeset	172 ##
27062 ffdfeb835aef warning_ids.m: Add docstring for new "Octave:empty-index" ID (bug #56167). Rik <rik@octave.org> parents: 26935 diff changeset	173 ## @item Octave:data-file-in-path
ffdfeb835aef warning_ids.m: Add docstring for new "Octave:empty-index" ID (bug #56167). Rik <rik@octave.org> parents: 26935 diff changeset	174 ## If the @code{Octave:data-file-in-path} warning is enabled, a warning is
ffdfeb835aef warning_ids.m: Add docstring for new "Octave:empty-index" ID (bug #56167). Rik <rik@octave.org> parents: 26935 diff changeset	175 ## issued when Octave does not find the target of a file operation such as
ffdfeb835aef warning_ids.m: Add docstring for new "Octave:empty-index" ID (bug #56167). Rik <rik@octave.org> parents: 26935 diff changeset	176 ## @code{load} or @code{fopen} directly, but is able to locate the file in
ffdfeb835aef warning_ids.m: Add docstring for new "Octave:empty-index" ID (bug #56167). Rik <rik@octave.org> parents: 26935 diff changeset	177 ## Octave's search @code{path} for files. The warning could indicate that a
ffdfeb835aef warning_ids.m: Add docstring for new "Octave:empty-index" ID (bug #56167). Rik <rik@octave.org> parents: 26935 diff changeset	178 ## different file target than the programmer intended is being used.
ffdfeb835aef warning_ids.m: Add docstring for new "Octave:empty-index" ID (bug #56167). Rik <rik@octave.org> parents: 26935 diff changeset	179 ## By default, the @code{Octave:data-file-in-path} warning is enabled.
ffdfeb835aef warning_ids.m: Add docstring for new "Octave:empty-index" ID (bug #56167). Rik <rik@octave.org> parents: 26935 diff changeset	180 ##
30648 c7a515aa767e datevec.m: Tweaks to cset e9bfb92dab01 for performance and documentation (bug #47627) Rik <rik@octave.org> parents: 30564 diff changeset	181 ## @item Octave:datevec:date-format-spec
c7a515aa767e datevec.m: Tweaks to cset e9bfb92dab01 for performance and documentation (bug #47627) Rik <rik@octave.org> parents: 30564 diff changeset	182 ## If the @code{Octave:datevec:date-format-spec} warning is enabled, a warning
c7a515aa767e datevec.m: Tweaks to cset e9bfb92dab01 for performance and documentation (bug #47627) Rik <rik@octave.org> parents: 30564 diff changeset	183 ## is printed if the date format specification contains questionable date or
31375 96f751f8392c doc: grammar check documentation ahead of 8.1 release. Rik <rik@octave.org> parents: 31038 diff changeset	184 ## time specifiers. Typical bad patterns are using uppercase date specifiers
96f751f8392c doc: grammar check documentation ahead of 8.1 release. Rik <rik@octave.org> parents: 31038 diff changeset	185 ## or lowercase time specifiers.
30648 c7a515aa767e datevec.m: Tweaks to cset e9bfb92dab01 for performance and documentation (bug #47627) Rik <rik@octave.org> parents: 30564 diff changeset	186 ## By default, the @code{Octave:datevec:date-format-spec} warning is enabled.
c7a515aa767e datevec.m: Tweaks to cset e9bfb92dab01 for performance and documentation (bug #47627) Rik <rik@octave.org> parents: 30564 diff changeset	187 ##
21654 a0ebc922fd52 Add "facenormals" and "normalsmode" to "surface" and "patch" (bug #47791) mmuetzel <markus.muetzel@gmx.de>* parents: 21546 diff changeset	188 ## @item Octave:deprecated-function
a0ebc922fd52 Add "facenormals" and "normalsmode" to "surface" and "patch" (bug #47791) mmuetzel <markus.muetzel@gmx.de>* parents: 21546 diff changeset	189 ## If the @code{Octave:deprecated-function} warning is enabled, a
a0ebc922fd52 Add "facenormals" and "normalsmode" to "surface" and "patch" (bug #47791) mmuetzel <markus.muetzel@gmx.de>* parents: 21546 diff changeset	190 ## warning is issued when Octave encounters a function that is obsolete and
a0ebc922fd52 Add "facenormals" and "normalsmode" to "surface" and "patch" (bug #47791) mmuetzel <markus.muetzel@gmx.de>* parents: 21546 diff changeset	191 ## scheduled for removal from Octave.
a0ebc922fd52 Add "facenormals" and "normalsmode" to "surface" and "patch" (bug #47791) mmuetzel <markus.muetzel@gmx.de>* parents: 21546 diff changeset	192 ## By default, the @code{Octave:deprecated-function} warning is enabled.
a0ebc922fd52 Add "facenormals" and "normalsmode" to "surface" and "patch" (bug #47791) mmuetzel <markus.muetzel@gmx.de>* parents: 21546 diff changeset	193 ##
15605 80a4ded6b89c warning_ids.m: Add 2 missing warning IDs to documentation. Rik <rik@octave.org> parents: 14366 diff changeset	194 ## @item Octave:deprecated-keyword
80a4ded6b89c warning_ids.m: Add 2 missing warning IDs to documentation. Rik <rik@octave.org> parents: 14366 diff changeset	195 ## If the @code{Octave:deprecated-keyword} warning is enabled, a
80a4ded6b89c warning_ids.m: Add 2 missing warning IDs to documentation. Rik <rik@octave.org> parents: 14366 diff changeset	196 ## warning is issued when Octave encounters a keyword that is obsolete and
80a4ded6b89c warning_ids.m: Add 2 missing warning IDs to documentation. Rik <rik@octave.org> parents: 14366 diff changeset	197 ## scheduled for removal from Octave.
80a4ded6b89c warning_ids.m: Add 2 missing warning IDs to documentation. Rik <rik@octave.org> parents: 14366 diff changeset	198 ## By default, the @code{Octave:deprecated-keyword} warning is enabled.
80a4ded6b89c warning_ids.m: Add 2 missing warning IDs to documentation. Rik <rik@octave.org> parents: 14366 diff changeset	199 ##
31037 39876ea8c588 warning_ids.m: Add new warning ID "Octave:deprecated-option". Rik <rik@octave.org> parents: 30650 diff changeset	200 ## @item Octave:deprecated-option
39876ea8c588 warning_ids.m: Add new warning ID "Octave:deprecated-option". Rik <rik@octave.org> parents: 30650 diff changeset	201 ## If the @code{Octave:deprecated-option} warning is enabled, a
39876ea8c588 warning_ids.m: Add new warning ID "Octave:deprecated-option". Rik <rik@octave.org> parents: 30650 diff changeset	202 ## warning is issued when an obsolete option or input to a function is used.
39876ea8c588 warning_ids.m: Add new warning ID "Octave:deprecated-option". Rik <rik@octave.org> parents: 30650 diff changeset	203 ## By default, the @code{Octave:deprecated-option} warning is enabled.
39876ea8c588 warning_ids.m: Add new warning ID "Octave:deprecated-option". Rik <rik@octave.org> parents: 30650 diff changeset	204 ##
21654 a0ebc922fd52 Add "facenormals" and "normalsmode" to "surface" and "patch" (bug #47791) mmuetzel <markus.muetzel@gmx.de>* parents: 21546 diff changeset	205 ## @item Octave:deprecated-property
a0ebc922fd52 Add "facenormals" and "normalsmode" to "surface" and "patch" (bug #47791) mmuetzel <markus.muetzel@gmx.de>* parents: 21546 diff changeset	206 ## If the @code{Octave:deprecated-property} warning is enabled, a
a0ebc922fd52 Add "facenormals" and "normalsmode" to "surface" and "patch" (bug #47791) mmuetzel <markus.muetzel@gmx.de>* parents: 21546 diff changeset	207 ## warning is issued when Octave encounters a graphics property that
a0ebc922fd52 Add "facenormals" and "normalsmode" to "surface" and "patch" (bug #47791) mmuetzel <markus.muetzel@gmx.de>* parents: 21546 diff changeset	208 ## is obsolete and scheduled for removal from Octave.
a0ebc922fd52 Add "facenormals" and "normalsmode" to "surface" and "patch" (bug #47791) mmuetzel <markus.muetzel@gmx.de>* parents: 21546 diff changeset	209 ## By default, the @code{Octave:deprecated-property} warning is enabled.
a0ebc922fd52 Add "facenormals" and "normalsmode" to "surface" and "patch" (bug #47791) mmuetzel <markus.muetzel@gmx.de>* parents: 21546 diff changeset	210 ##
24334 d3d38a443df8 Add new warning ID "Octave:eigs:UnconvergedEigenvalues". Rik <rik@octave.org> parents: 24034 diff changeset	211 ## @item Octave:eigs:UnconvergedEigenvalues
d3d38a443df8 Add new warning ID "Octave:eigs:UnconvergedEigenvalues". Rik <rik@octave.org> parents: 24034 diff changeset	212 ## If the @code{Octave:eigs:UnconvergedEigenvalues} warning is enabled then
d3d38a443df8 Add new warning ID "Octave:eigs:UnconvergedEigenvalues". Rik <rik@octave.org> parents: 24034 diff changeset	213 ## the eigs function will issue a warning if the number of calculated
d3d38a443df8 Add new warning ID "Octave:eigs:UnconvergedEigenvalues". Rik <rik@octave.org> parents: 24034 diff changeset	214 ## eigenvalues is less than the number of requested eigenvalues.
d3d38a443df8 Add new warning ID "Octave:eigs:UnconvergedEigenvalues". Rik <rik@octave.org> parents: 24034 diff changeset	215 ## By default, the @code{Octave:eigs:UnconvergedEigenvalues} warning is
d3d38a443df8 Add new warning ID "Octave:eigs:UnconvergedEigenvalues". Rik <rik@octave.org> parents: 24034 diff changeset	216 ## enabled.
d3d38a443df8 Add new warning ID "Octave:eigs:UnconvergedEigenvalues". Rik <rik@octave.org> parents: 24034 diff changeset	217 ##
27062 ffdfeb835aef warning_ids.m: Add docstring for new "Octave:empty-index" ID (bug #56167). Rik <rik@octave.org> parents: 26935 diff changeset	218 ## @item Octave:empty-index
27066 2fd1ee5574d7 doc: Fix typo in cset ffdfeb835aef. Rik <rik@octave.org> parents: 27062 diff changeset	219 ## If the @code{Octave:empty-index} warning is enabled then Octave will emit a
27062 ffdfeb835aef warning_ids.m: Add docstring for new "Octave:empty-index" ID (bug #56167). Rik <rik@octave.org> parents: 26935 diff changeset	220 ## warning whenever indexing operators are used without an index, for example
ffdfeb835aef warning_ids.m: Add docstring for new "Octave:empty-index" ID (bug #56167). Rik <rik@octave.org> parents: 26935 diff changeset	221 ## @code{@var{x}()}.
ffdfeb835aef warning_ids.m: Add docstring for new "Octave:empty-index" ID (bug #56167). Rik <rik@octave.org> parents: 26935 diff changeset	222 ## By default, the @code{Octave:empty-index} warning is enabled.
ffdfeb835aef warning_ids.m: Add docstring for new "Octave:empty-index" ID (bug #56167). Rik <rik@octave.org> parents: 26935 diff changeset	223 ##
24473 42d099b841aa erase.m: Add warning if a character array is used for PTN. Rik <rik@octave.org> parents: 24334 diff changeset	224 ## @item Octave:erase:chararray
42d099b841aa erase.m: Add warning if a character array is used for PTN. Rik <rik@octave.org> parents: 24334 diff changeset	225 ## If the @code{Octave:erase:chararray} warning is enabled then the erase
42d099b841aa erase.m: Add warning if a character array is used for PTN. Rik <rik@octave.org> parents: 24334 diff changeset	226 ## function will issue a warning if the input pattern is a character array
42d099b841aa erase.m: Add warning if a character array is used for PTN. Rik <rik@octave.org> parents: 24334 diff changeset	227 ## rather than a string or cell array of strings.
25579 07c2c42f457e doc: Miscellaneous documentation fixes all over the manual (bug #54288). Rik <rik@octave.org> parents: 25183 diff changeset	228 ## By default, the @code{Octave:erase:chararray} warning is enabled.
24473 42d099b841aa erase.m: Add warning if a character array is used for PTN. Rik <rik@octave.org> parents: 24334 diff changeset	229 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	230 ## @item Octave:function-name-clash
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	231 ## If the @code{Octave:function-name-clash} warning is enabled, a
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	232 ## warning is issued when Octave finds that the name of a function
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	233 ## defined in a function file differs from the name of the file. (If
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	234 ## the names disagree, the name declared inside the file is ignored.)
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	235 ## By default, the @code{Octave:function-name-clash} warning is enabled.
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	236 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	237 ## @item Octave:future-time-stamp
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	238 ## If the @code{Octave:future-time-stamp} warning is enabled, Octave
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	239 ## will print a warning if it finds a function file with a time stamp
13841 0a158dbdb04a Remove 3 unused warning ids Rik <octave@nomad.inbox5.com> parents: 12845 diff changeset	240 ## that is in the future.
0a158dbdb04a Remove 3 unused warning ids Rik <octave@nomad.inbox5.com> parents: 12845 diff changeset	241 ## By default, the @code{Octave:future-time-stamp} warning is enabled.
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	242 ##
13842 4aadd3e2c5bc warning_ids.m: Add missing warnings to list. They are not documented. Rik <octave@nomad.inbox5.com> parents: 13841 diff changeset	243 ## @item Octave:glyph-render
28279 50ced8ab6387 warning_ids.m: Remove unused warning ids (bug #58396). Markus Mützel <markus.muetzel@gmx.de> parents: 27923 diff changeset	244 ## If the @code{Octave:glyph-render} warning is enabled, Octave will
50ced8ab6387 warning_ids.m: Remove unused warning ids (bug #58396). Markus Mützel <markus.muetzel@gmx.de> parents: 27923 diff changeset	245 ## print a warning if the glyph for a character couldn't be rendered with
50ced8ab6387 warning_ids.m: Remove unused warning ids (bug #58396). Markus Mützel <markus.muetzel@gmx.de> parents: 27923 diff changeset	246 ## the current font.
13842 4aadd3e2c5bc warning_ids.m: Add missing warnings to list. They are not documented. Rik <octave@nomad.inbox5.com> parents: 13841 diff changeset	247 ## By default, the @code{Octave:glyph-render} warning is enabled.
4aadd3e2c5bc warning_ids.m: Add missing warnings to list. They are not documented. Rik <octave@nomad.inbox5.com> parents: 13841 diff changeset	248 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	249 ## @item Octave:imag-to-real
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	250 ## If the @code{Octave:imag-to-real} warning is enabled, a warning is
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	251 ## printed for implicit conversions of complex numbers to real numbers.
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	252 ## By default, the @code{Octave:imag-to-real} warning is disabled.
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	253 ##
28593 a9f1a922367b New warning ID "Octave:infinite-loop" (bug #45143). Rik <rik@octave.org> parents: 28480 diff changeset	254 ## @item Octave:infinite-loop
a9f1a922367b New warning ID "Octave:infinite-loop" (bug #45143). Rik <rik@octave.org> parents: 28480 diff changeset	255 ## If the @code{Octave:infinite-loop} warning is enabled, a warning is
a9f1a922367b New warning ID "Octave:infinite-loop" (bug #45143). Rik <rik@octave.org> parents: 28480 diff changeset	256 ## printed when an infinite loop is detected such as @code{for i = 1:Inf} or
a9f1a922367b New warning ID "Octave:infinite-loop" (bug #45143). Rik <rik@octave.org> parents: 28480 diff changeset	257 ## @code{while (1)}.
a9f1a922367b New warning ID "Octave:infinite-loop" (bug #45143). Rik <rik@octave.org> parents: 28480 diff changeset	258 ## By default, the @code{Octave:infinite-loop} warning is enabled.
a9f1a922367b New warning ID "Octave:infinite-loop" (bug #45143). Rik <rik@octave.org> parents: 28480 diff changeset	259 ##
19852 e9a0bd0b125c Rename 'matlab-incompatible' warning to 'language-extension'. Carnë Draug <carandraug@octave.org> parents: 19851 diff changeset	260 ## @item Octave:language-extension
e9a0bd0b125c Rename 'matlab-incompatible' warning to 'language-extension'. Carnë Draug <carandraug@octave.org> parents: 19851 diff changeset	261 ## Print warnings when using features that are unique to the Octave
20101 e51473fdb622 doc: Periodic grammarcheck of documentation. Rik <rik@octave.org> parents: 19852 diff changeset	262 ## language and that may still be missing in @sc{matlab}.
19852 e9a0bd0b125c Rename 'matlab-incompatible' warning to 'language-extension'. Carnë Draug <carandraug@octave.org> parents: 19851 diff changeset	263 ## By default, the @code{Octave:language-extension} warning is disabled.
20101 e51473fdb622 doc: Periodic grammarcheck of documentation. Rik <rik@octave.org> parents: 19852 diff changeset	264 ## The @option{--traditional} or @option{--braindead} startup options for
e51473fdb622 doc: Periodic grammarcheck of documentation. Rik <rik@octave.org> parents: 19852 diff changeset	265 ## Octave may also be of use, @pxref{Command Line Options}.
19852 e9a0bd0b125c Rename 'matlab-incompatible' warning to 'language-extension'. Carnë Draug <carandraug@octave.org> parents: 19851 diff changeset	266 ##
25720 e9f107d31799 warning_ids.m: Document new Octave:legacy-function warning. Rik <rik@octave.org> parents: 25579 diff changeset	267 ## @item Octave:legacy-function
e9f107d31799 warning_ids.m: Document new Octave:legacy-function warning. Rik <rik@octave.org> parents: 25579 diff changeset	268 ## If the @code{Octave:legacy-function} warning is enabled, a
26043 5cef57130cb9 doc: grammar check m-files in scripts/ directory. Rik <rik@octave.org> parents: 25720 diff changeset	269 ## warning is issued when Octave encounters a function that @sc{matlab} has
25720 e9f107d31799 warning_ids.m: Document new Octave:legacy-function warning. Rik <rik@octave.org> parents: 25579 diff changeset	270 ## suggested should be avoided. The function may become obsolete at some
e9f107d31799 warning_ids.m: Document new Octave:legacy-function warning. Rik <rik@octave.org> parents: 25579 diff changeset	271 ## point in the future and removed, in which case the warning will change to
e9f107d31799 warning_ids.m: Document new Octave:legacy-function warning. Rik <rik@octave.org> parents: 25579 diff changeset	272 ## @code{Octave:deprecated-function}, and the function will continue to exist
e9f107d31799 warning_ids.m: Document new Octave:legacy-function warning. Rik <rik@octave.org> parents: 25579 diff changeset	273 ## for two further versions of Octave before being removed.
e9f107d31799 warning_ids.m: Document new Octave:legacy-function warning. Rik <rik@octave.org> parents: 25579 diff changeset	274 ## By default, the @code{Octave:legacy-function} warning is enabled.
e9f107d31799 warning_ids.m: Document new Octave:legacy-function warning. Rik <rik@octave.org> parents: 25579 diff changeset	275 ##
13842 4aadd3e2c5bc warning_ids.m: Add missing warnings to list. They are not documented. Rik <octave@nomad.inbox5.com> parents: 13841 diff changeset	276 ## @item Octave:logical-conversion
30315 8a80c89b021e warning_ids.m: fill in missing warning descriptions (bug #39434) Nicholas R. Jankowski <jankowskin@asme.org> parents: 29359 diff changeset	277 ## If the @code{Octave:logical-conversion} warning is enabled, a warning is
8a80c89b021e warning_ids.m: fill in missing warning descriptions (bug #39434) Nicholas R. Jankowski <jankowskin@asme.org> parents: 29359 diff changeset	278 ## printed if an implicit conversion of an array from numerical to boolean
8a80c89b021e warning_ids.m: fill in missing warning descriptions (bug #39434) Nicholas R. Jankowski <jankowskin@asme.org> parents: 29359 diff changeset	279 ## occurs and any of the elements in the array are not equal to zero or one.
13842 4aadd3e2c5bc warning_ids.m: Add missing warnings to list. They are not documented. Rik <octave@nomad.inbox5.com> parents: 13841 diff changeset	280 ## By default, the @code{Octave:logical-conversion} warning is enabled.
4aadd3e2c5bc warning_ids.m: Add missing warnings to list. They are not documented. Rik <octave@nomad.inbox5.com> parents: 13841 diff changeset	281 ##
25037 1c077d652c57 Add new warning ID and message when lu is called with sparse input incorrectly (bug #53390). Rik <rik@octave.org> parents: 24963 diff changeset	282 ## @item Octave:lu:sparse_input
1c077d652c57 Add new warning ID and message when lu is called with sparse input incorrectly (bug #53390). Rik <rik@octave.org> parents: 24963 diff changeset	283 ## If the @code{Octave:lu:sparse_input} warning is enabled, Octave
1c077d652c57 Add new warning ID and message when lu is called with sparse input incorrectly (bug #53390). Rik <rik@octave.org> parents: 24963 diff changeset	284 ## will warn when the lu function is called with a sparse input and less than
1c077d652c57 Add new warning ID and message when lu is called with sparse input incorrectly (bug #53390). Rik <rik@octave.org> parents: 24963 diff changeset	285 ## four output arguments. In this case, sparsity-preserving column
1c077d652c57 Add new warning ID and message when lu is called with sparse input incorrectly (bug #53390). Rik <rik@octave.org> parents: 24963 diff changeset	286 ## permutations are not performed and the result may be inaccurate.
1c077d652c57 Add new warning ID and message when lu is called with sparse input incorrectly (bug #53390). Rik <rik@octave.org> parents: 24963 diff changeset	287 ## By default, the @code{Octave:lu:sparse_input} warning is enabled.
1c077d652c57 Add new warning ID and message when lu is called with sparse input incorrectly (bug #53390). Rik <rik@octave.org> parents: 24963 diff changeset	288 ##
13842 4aadd3e2c5bc warning_ids.m: Add missing warnings to list. They are not documented. Rik <octave@nomad.inbox5.com> parents: 13841 diff changeset	289 ## @item Octave:missing-glyph
28279 50ced8ab6387 warning_ids.m: Remove unused warning ids (bug #58396). Markus Mützel <markus.muetzel@gmx.de> parents: 27923 diff changeset	290 ## If the @code{Octave:glyph-render} warning is enabled, Octave will
50ced8ab6387 warning_ids.m: Remove unused warning ids (bug #58396). Markus Mützel <markus.muetzel@gmx.de> parents: 27923 diff changeset	291 ## print a warning if the current font doesn't provide a glyph for a
50ced8ab6387 warning_ids.m: Remove unused warning ids (bug #58396). Markus Mützel <markus.muetzel@gmx.de> parents: 27923 diff changeset	292 ## used character.
13842 4aadd3e2c5bc warning_ids.m: Add missing warnings to list. They are not documented. Rik <octave@nomad.inbox5.com> parents: 13841 diff changeset	293 ## By default, the @code{Octave:missing-glyph} warning is enabled.
4aadd3e2c5bc warning_ids.m: Add missing warnings to list. They are not documented. Rik <octave@nomad.inbox5.com> parents: 13841 diff changeset	294 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	295 ## @item Octave:missing-semicolon
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	296 ## If the @code{Octave:missing-semicolon} warning is enabled, Octave
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	297 ## will warn when statements in function definitions don't end in
13841 0a158dbdb04a Remove 3 unused warning ids Rik <octave@nomad.inbox5.com> parents: 12845 diff changeset	298 ## semicolons.
0a158dbdb04a Remove 3 unused warning ids Rik <octave@nomad.inbox5.com> parents: 12845 diff changeset	299 ## By default the @code{Octave:missing-semicolon} warning is disabled.
0a158dbdb04a Remove 3 unused warning ids Rik <octave@nomad.inbox5.com> parents: 12845 diff changeset	300 ##
0a158dbdb04a Remove 3 unused warning ids Rik <octave@nomad.inbox5.com> parents: 12845 diff changeset	301 ## @item Octave:mixed-string-concat
0a158dbdb04a Remove 3 unused warning ids Rik <octave@nomad.inbox5.com> parents: 12845 diff changeset	302 ## If the @code{Octave:mixed-string-concat} warning is enabled, print a
0a158dbdb04a Remove 3 unused warning ids Rik <octave@nomad.inbox5.com> parents: 12845 diff changeset	303 ## warning when concatenating a mixture of double and single quoted strings.
0a158dbdb04a Remove 3 unused warning ids Rik <octave@nomad.inbox5.com> parents: 12845 diff changeset	304 ## By default, the @code{Octave:mixed-string-concat} warning is disabled.
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	305 ##
24963 2e4ed4250e52 warning_ids.m: alphabetic order nearly-singular-matrix Juan Pablo Carbajal <ajuanpi+dev@gmail.com> parents: 24534 diff changeset	306 ## @item Octave:nearly-singular-matrix
2e4ed4250e52 warning_ids.m: alphabetic order nearly-singular-matrix Juan Pablo Carbajal <ajuanpi+dev@gmail.com> parents: 24534 diff changeset	307 ## @itemx Octave:singular-matrix
26577 ae1542fb58ba documentation: Avoid some overfull lines in the PDF manual. Markus Mützel <markus.muetzel@gmx.de> parents: 26575 diff changeset	308 ## These warnings are emitted if a (nearly) singular matrix is inverted.
24963 2e4ed4250e52 warning_ids.m: alphabetic order nearly-singular-matrix Juan Pablo Carbajal <ajuanpi+dev@gmail.com> parents: 24534 diff changeset	309 ## By default, the @code{Octave:nearly-singular-matrix} and
2e4ed4250e52 warning_ids.m: alphabetic order nearly-singular-matrix Juan Pablo Carbajal <ajuanpi+dev@gmail.com> parents: 24534 diff changeset	310 ## @code{Octave:singular-matrix} warnings are enabled.
2e4ed4250e52 warning_ids.m: alphabetic order nearly-singular-matrix Juan Pablo Carbajal <ajuanpi+dev@gmail.com> parents: 24534 diff changeset	311 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	312 ## @item Octave:neg-dim-as-zero
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	313 ## If the @code{Octave:neg-dim-as-zero} warning is enabled, print a warning
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	314 ## for expressions like
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	315 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	316 ## @example
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	317 ## eye (-1)
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	318 ## @end example
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	319 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	320 ## @noindent
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	321 ## By default, the @code{Octave:neg-dim-as-zero} warning is disabled.
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	322 ##
13842 4aadd3e2c5bc warning_ids.m: Add missing warnings to list. They are not documented. Rik <octave@nomad.inbox5.com> parents: 13841 diff changeset	323 ## @item Octave:noninteger-range-as-index
30315 8a80c89b021e warning_ids.m: fill in missing warning descriptions (bug #39434) Nicholas R. Jankowski <jankowskin@asme.org> parents: 29359 diff changeset	324 ## If the @code{Octave:noninteger-range-as-index} warning is enabled, a warning
8a80c89b021e warning_ids.m: fill in missing warning descriptions (bug #39434) Nicholas R. Jankowski <jankowskin@asme.org> parents: 29359 diff changeset	325 ## is printed if an array is indexed with a range that contains non-integer
8a80c89b021e warning_ids.m: fill in missing warning descriptions (bug #39434) Nicholas R. Jankowski <jankowskin@asme.org> parents: 29359 diff changeset	326 ## values. For example,
8a80c89b021e warning_ids.m: fill in missing warning descriptions (bug #39434) Nicholas R. Jankowski <jankowskin@asme.org> parents: 29359 diff changeset	327 ##
8a80c89b021e warning_ids.m: fill in missing warning descriptions (bug #39434) Nicholas R. Jankowski <jankowskin@asme.org> parents: 29359 diff changeset	328 ## @example
8a80c89b021e warning_ids.m: fill in missing warning descriptions (bug #39434) Nicholas R. Jankowski <jankowskin@asme.org> parents: 29359 diff changeset	329 ## @group
8a80c89b021e warning_ids.m: fill in missing warning descriptions (bug #39434) Nicholas R. Jankowski <jankowskin@asme.org> parents: 29359 diff changeset	330 ## a = [1 2 3 4 5];
8a80c89b021e warning_ids.m: fill in missing warning descriptions (bug #39434) Nicholas R. Jankowski <jankowskin@asme.org> parents: 29359 diff changeset	331 ## b = 2.2:4.2
8a80c89b021e warning_ids.m: fill in missing warning descriptions (bug #39434) Nicholas R. Jankowski <jankowskin@asme.org> parents: 29359 diff changeset	332 ## @result{} 1.2 2.2 3.2
8a80c89b021e warning_ids.m: fill in missing warning descriptions (bug #39434) Nicholas R. Jankowski <jankowskin@asme.org> parents: 29359 diff changeset	333 ## a(b)
8a80c89b021e warning_ids.m: fill in missing warning descriptions (bug #39434) Nicholas R. Jankowski <jankowskin@asme.org> parents: 29359 diff changeset	334 ## @result{} 2 3 4
8a80c89b021e warning_ids.m: fill in missing warning descriptions (bug #39434) Nicholas R. Jankowski <jankowskin@asme.org> parents: 29359 diff changeset	335 ## @end group
8a80c89b021e warning_ids.m: fill in missing warning descriptions (bug #39434) Nicholas R. Jankowski <jankowskin@asme.org> parents: 29359 diff changeset	336 ## @end example
8a80c89b021e warning_ids.m: fill in missing warning descriptions (bug #39434) Nicholas R. Jankowski <jankowskin@asme.org> parents: 29359 diff changeset	337 ##
8a80c89b021e warning_ids.m: fill in missing warning descriptions (bug #39434) Nicholas R. Jankowski <jankowskin@asme.org> parents: 29359 diff changeset	338 ## @noindent
8a80c89b021e warning_ids.m: fill in missing warning descriptions (bug #39434) Nicholas R. Jankowski <jankowskin@asme.org> parents: 29359 diff changeset	339 ## elicits a warning if the @code{Octave:noninteger-range-as-index} warning is
8a80c89b021e warning_ids.m: fill in missing warning descriptions (bug #39434) Nicholas R. Jankowski <jankowskin@asme.org> parents: 29359 diff changeset	340 ## enabled.
13842 4aadd3e2c5bc warning_ids.m: Add missing warnings to list. They are not documented. Rik <octave@nomad.inbox5.com> parents: 13841 diff changeset	341 ## By default, the @code{Octave:noninteger-range-as-index} warning is enabled.
4aadd3e2c5bc warning_ids.m: Add missing warnings to list. They are not documented. Rik <octave@nomad.inbox5.com> parents: 13841 diff changeset	342 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	343 ## @item Octave:num-to-str
30315 8a80c89b021e warning_ids.m: fill in missing warning descriptions (bug #39434) Nicholas R. Jankowski <jankowskin@asme.org> parents: 29359 diff changeset	344 ## If the @code{Octave:num-to-str} warning is enabled, a warning is
26575 3e7fa894731a documentation: Replace ASCII with UTF-8 where it is more correct. Markus Mützel <markus.muetzel@gmx.de> parents: 26376 diff changeset	345 ## printed for implicit conversions of numbers to their UTF-8 encoded character
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	346 ## equivalents when strings are constructed using a mixture of strings and
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	347 ## numbers in matrix notation. For example,
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	348 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	349 ## @example
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	350 ## @group
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	351 ## [ "f", 111, 111 ]
14327 4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	352 ## @result{} "foo"
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	353 ## @end group
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	354 ## @end example
10821 693e22af08ae Grammarcheck documentation of m-files Rik <octave@nomad.inbox5.com> parents: 9051 diff changeset	355 ##
10846 a4f482e66b65 Grammarcheck more of the documentation. Rik <octave@nomad.inbox5.com> parents: 10821 diff changeset	356 ## @noindent
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	357 ## elicits a warning if the @code{Octave:num-to-str} warning is
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	358 ## enabled. By default, the @code{Octave:num-to-str} warning is enabled.
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	359 ##
12477 d1466d956d17 Add a warning description for Matlab-style short-circuiting Jordi Gutiérrez Hermoso <jordigh@gmail.com> parents: 11587 diff changeset	360 ## @item Octave:possible-matlab-short-circuit-operator
d1466d956d17 Add a warning description for Matlab-style short-circuiting Jordi Gutiérrez Hermoso <jordigh@gmail.com> parents: 11587 diff changeset	361 ## If the @code{Octave:possible-matlab-short-circuit-operator} warning
d1466d956d17 Add a warning description for Matlab-style short-circuiting Jordi Gutiérrez Hermoso <jordigh@gmail.com> parents: 11587 diff changeset	362 ## is enabled, Octave will warn about using the not short circuiting
d1466d956d17 Add a warning description for Matlab-style short-circuiting Jordi Gutiérrez Hermoso <jordigh@gmail.com> parents: 11587 diff changeset	363 ## operators @code{&} and @code{\|} inside @code{if} or @code{while}
24034 18efaf716530 doc: don't mention do_braindead_shortcircuit_evaluation in warning_ids (bug #51999) Mike Miller <mtmiller@octave.org> parents: 23994 diff changeset	364 ## conditions. They normally never short circuit, but they do short
18efaf716530 doc: don't mention do_braindead_shortcircuit_evaluation in warning_ids (bug #51999) Mike Miller <mtmiller@octave.org> parents: 23994 diff changeset	365 ## circuit when used in a condition.
13841 0a158dbdb04a Remove 3 unused warning ids Rik <octave@nomad.inbox5.com> parents: 12845 diff changeset	366 ## By default, the @code{Octave:possible-matlab-short-circuit-operator} warning
0a158dbdb04a Remove 3 unused warning ids Rik <octave@nomad.inbox5.com> parents: 12845 diff changeset	367 ## is enabled.
12477 d1466d956d17 Add a warning description for Matlab-style short-circuiting Jordi Gutiérrez Hermoso <jordigh@gmail.com> parents: 11587 diff changeset	368 ##
30719 a885bdb22374 maint: tweaks to cset a7c4fb821d64 (pow2). Rik <rik@octave.org> parents: 30651 diff changeset	369 ## @item Octave:pow2:imaginary-ignored
a885bdb22374 maint: tweaks to cset a7c4fb821d64 (pow2). Rik <rik@octave.org> parents: 30651 diff changeset	370 ## If the @code{Octave:pow2:imaginary-ignored} warning is enabled, a warning is
a885bdb22374 maint: tweaks to cset a7c4fb821d64 (pow2). Rik <rik@octave.org> parents: 30651 diff changeset	371 ## printed if either input to @code{pow2} is complex.
a885bdb22374 maint: tweaks to cset a7c4fb821d64 (pow2). Rik <rik@octave.org> parents: 30651 diff changeset	372 ## By default, the @code{Octave:pow2:imaginary-ignored} warning is enabled.
a885bdb22374 maint: tweaks to cset a7c4fb821d64 (pow2). Rik <rik@octave.org> parents: 30651 diff changeset	373 ##
13842 4aadd3e2c5bc warning_ids.m: Add missing warnings to list. They are not documented. Rik <octave@nomad.inbox5.com> parents: 13841 diff changeset	374 ## @item Octave:recursive-path-search
28279 50ced8ab6387 warning_ids.m: Remove unused warning ids (bug #58396). Markus Mützel <markus.muetzel@gmx.de> parents: 27923 diff changeset	375 ## If the @code{Octave:recursive-path-search} warning is enabled, Octave
50ced8ab6387 warning_ids.m: Remove unused warning ids (bug #58396). Markus Mützel <markus.muetzel@gmx.de> parents: 27923 diff changeset	376 ## will issue a warning if @code{addpath} is used with double trailing
50ced8ab6387 warning_ids.m: Remove unused warning ids (bug #58396). Markus Mützel <markus.muetzel@gmx.de> parents: 27923 diff changeset	377 ## slashes.
13842 4aadd3e2c5bc warning_ids.m: Add missing warnings to list. They are not documented. Rik <octave@nomad.inbox5.com> parents: 13841 diff changeset	378 ## By default, the @code{Octave:recursive-path-search} warning is enabled.
4aadd3e2c5bc warning_ids.m: Add missing warnings to list. They are not documented. Rik <octave@nomad.inbox5.com> parents: 13841 diff changeset	379 ##
15605 80a4ded6b89c warning_ids.m: Add 2 missing warning IDs to documentation. Rik <rik@octave.org> parents: 14366 diff changeset	380 ## @item Octave:remove-init-dir
80a4ded6b89c warning_ids.m: Add 2 missing warning IDs to documentation. Rik <rik@octave.org> parents: 14366 diff changeset	381 ## The @code{path} function changes the search path that Octave uses
80a4ded6b89c warning_ids.m: Add 2 missing warning IDs to documentation. Rik <rik@octave.org> parents: 14366 diff changeset	382 ## to find functions. It is possible to set the path to a value which
80a4ded6b89c warning_ids.m: Add 2 missing warning IDs to documentation. Rik <rik@octave.org> parents: 14366 diff changeset	383 ## excludes Octave's own built-in functions. If the
80a4ded6b89c warning_ids.m: Add 2 missing warning IDs to documentation. Rik <rik@octave.org> parents: 14366 diff changeset	384 ## @code{Octave:remove-init-dir} warning is enabled then Octave will warn
80a4ded6b89c warning_ids.m: Add 2 missing warning IDs to documentation. Rik <rik@octave.org> parents: 14366 diff changeset	385 ## when the @code{path} function has been used in a way that may render
80a4ded6b89c warning_ids.m: Add 2 missing warning IDs to documentation. Rik <rik@octave.org> parents: 14366 diff changeset	386 ## Octave unworkable.
80a4ded6b89c warning_ids.m: Add 2 missing warning IDs to documentation. Rik <rik@octave.org> parents: 14366 diff changeset	387 ## By default, the @code{Octave:remove-init-dir} warning is enabled.
80a4ded6b89c warning_ids.m: Add 2 missing warning IDs to documentation. Rik <rik@octave.org> parents: 14366 diff changeset	388 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	389 ## @item Octave:reload-forces-clear
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	390 ## If several functions have been loaded from the same file, Octave must
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	391 ## clear all the functions before any one of them can be reloaded. If
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	392 ## the @code{Octave:reload-forces-clear} warning is enabled, Octave will
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	393 ## warn you when this happens, and print a list of the additional
13841 0a158dbdb04a Remove 3 unused warning ids Rik <octave@nomad.inbox5.com> parents: 12845 diff changeset	394 ## functions that it is forced to clear.
0a158dbdb04a Remove 3 unused warning ids Rik <octave@nomad.inbox5.com> parents: 12845 diff changeset	395 ## By default, the @code{Octave:reload-forces-clear} warning is enabled.
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	396 ##
5794 1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5781 diff changeset	397 ## @item Octave:separator-insert
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5781 diff changeset	398 ## Print warning if commas or semicolons might be inserted
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5781 diff changeset	399 ## automatically in literal matrices.
13841 0a158dbdb04a Remove 3 unused warning ids Rik <octave@nomad.inbox5.com> parents: 12845 diff changeset	400 ## By default, the @code{Octave:separator-insert} warning is disabled.
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	401 ##
13842 4aadd3e2c5bc warning_ids.m: Add missing warnings to list. They are not documented. Rik <octave@nomad.inbox5.com> parents: 13841 diff changeset	402 ## @item Octave:shadowed-function
28279 50ced8ab6387 warning_ids.m: Remove unused warning ids (bug #58396). Markus Mützel <markus.muetzel@gmx.de> parents: 27923 diff changeset	403 ## If the @code{Octave:shadowed-function} warning is enabled, Octave will
50ced8ab6387 warning_ids.m: Remove unused warning ids (bug #58396). Markus Mützel <markus.muetzel@gmx.de> parents: 27923 diff changeset	404 ## warn if a path is added to the search path that contains functions
50ced8ab6387 warning_ids.m: Remove unused warning ids (bug #58396). Markus Mützel <markus.muetzel@gmx.de> parents: 27923 diff changeset	405 ## that shadow core functions.
13842 4aadd3e2c5bc warning_ids.m: Add missing warnings to list. They are not documented. Rik <octave@nomad.inbox5.com> parents: 13841 diff changeset	406 ## By default, the @code{Octave:shadowed-function} warning is enabled.
4aadd3e2c5bc warning_ids.m: Add missing warnings to list. They are not documented. Rik <octave@nomad.inbox5.com> parents: 13841 diff changeset	407 ##
5794 1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5781 diff changeset	408 ## @item Octave:single-quote-string
8325 b93ac0586e4b spelling corrections Brian Gough<bjg@network-theory.co.uk> parents: 7017 diff changeset	409 ## Print warning if a single quote character is used to introduce a
5794 1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5781 diff changeset	410 ## string constant.
13841 0a158dbdb04a Remove 3 unused warning ids Rik <octave@nomad.inbox5.com> parents: 12845 diff changeset	411 ## By default, the @code{Octave:single-quote-string} warning is disabled.
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	412 ##
32058 e242124f1240 Overhaul input validation of sparse() function. Rik <rik@octave.org> parents: 31706 diff changeset	413 ## @item Octave:sparse:double-conversion
e242124f1240 Overhaul input validation of sparse() function. Rik <rik@octave.org> parents: 31706 diff changeset	414 ## If the @code{Octave:sparse:double-conversion} warning is enabled, a warning
e242124f1240 Overhaul input validation of sparse() function. Rik <rik@octave.org> parents: 31706 diff changeset	415 ## is printed when an implicit conversion from a full, single array occurs
e242124f1240 Overhaul input validation of sparse() function. Rik <rik@octave.org> parents: 31706 diff changeset	416 ## during the creation of a sparse array.
e242124f1240 Overhaul input validation of sparse() function. Rik <rik@octave.org> parents: 31706 diff changeset	417 ## By default, the @code{Octave:sparse:double-conversion} warning is enabled.
e242124f1240 Overhaul input validation of sparse() function. Rik <rik@octave.org> parents: 31706 diff changeset	418 ##
13842 4aadd3e2c5bc warning_ids.m: Add missing warnings to list. They are not documented. Rik <octave@nomad.inbox5.com> parents: 13841 diff changeset	419 ## @item Octave:sqrtm:SingularMatrix
30315 8a80c89b021e warning_ids.m: fill in missing warning descriptions (bug #39434) Nicholas R. Jankowski <jankowskin@asme.org> parents: 29359 diff changeset	420 ## If the @code{Octave:sqrtm:SingularMatrix} warning is enabled, a warning is
8a80c89b021e warning_ids.m: fill in missing warning descriptions (bug #39434) Nicholas R. Jankowski <jankowskin@asme.org> parents: 29359 diff changeset	421 ## printed if the matrix square root function @code{sqrtm} is called with an
8a80c89b021e warning_ids.m: fill in missing warning descriptions (bug #39434) Nicholas R. Jankowski <jankowskin@asme.org> parents: 29359 diff changeset	422 ## input matrix that is singular.
13842 4aadd3e2c5bc warning_ids.m: Add missing warnings to list. They are not documented. Rik <octave@nomad.inbox5.com> parents: 13841 diff changeset	423 ## By default, the @code{Octave:sqrtm:SingularMatrix} warning is enabled.
4aadd3e2c5bc warning_ids.m: Add missing warnings to list. They are not documented. Rik <octave@nomad.inbox5.com> parents: 13841 diff changeset	424 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	425 ## @item Octave:str-to-num
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	426 ## If the @code{Octave:str-to-num} warning is enabled, a warning is printed
26575 3e7fa894731a documentation: Replace ASCII with UTF-8 where it is more correct. Markus Mützel <markus.muetzel@gmx.de> parents: 26376 diff changeset	427 ## for implicit conversions of strings to their numeric UTF-8 encoded byte
3e7fa894731a documentation: Replace ASCII with UTF-8 where it is more correct. Markus Mützel <markus.muetzel@gmx.de> parents: 26376 diff changeset	428 ## sequences. For example,
10821 693e22af08ae Grammarcheck documentation of m-files Rik <octave@nomad.inbox5.com> parents: 9051 diff changeset	429 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	430 ## @example
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	431 ## @group
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	432 ## "abc" + 0
14327 4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	433 ## @result{} 97 98 99
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	434 ## @end group
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	435 ## @end example
10821 693e22af08ae Grammarcheck documentation of m-files Rik <octave@nomad.inbox5.com> parents: 9051 diff changeset	436 ##
10846 a4f482e66b65 Grammarcheck more of the documentation. Rik <octave@nomad.inbox5.com> parents: 10821 diff changeset	437 ## @noindent
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	438 ## elicits a warning if the @code{Octave:str-to-num} warning is enabled.
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	439 ## By default, the @code{Octave:str-to-num} warning is disabled.
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	440 ##
30650 b20da6bed444 warning_ids.m: Add warning ID "Octave:LaTeX:internal-error". Rik <rik@octave.org> parents: 30564 diff changeset	441 ## @item Octave:LaTeX:internal-error
b20da6bed444 warning_ids.m: Add warning ID "Octave:LaTeX:internal-error". Rik <rik@octave.org> parents: 30564 diff changeset	442 ## If the @code{Octave:LaTeX:internal-error} warning is enabled, a warning is
31593 0f93c3a756f7 doc: grammarcheck documentation ahead of 8.1 release. Rik <rik@octave.org> parents: 31375 diff changeset	443 ## printed whenever the @LaTeX{} renderer for text in plots encounters an
0f93c3a756f7 doc: grammarcheck documentation ahead of 8.1 release. Rik <rik@octave.org> parents: 31375 diff changeset	444 ## issue.
30650 b20da6bed444 warning_ids.m: Add warning ID "Octave:LaTeX:internal-error". Rik <rik@octave.org> parents: 30564 diff changeset	445 ## By default, the @code{Octave:LaTeX:internal-error} warning is enabled.
27062 ffdfeb835aef warning_ids.m: Add docstring for new "Octave:empty-index" ID (bug #56167). Rik <rik@octave.org> parents: 26935 diff changeset	446 ##
28477 7ea82a190029 Add new warning ID "Octave:unimplemented-matlab-functionality". Rik <rik@octave.org> parents: 28279 diff changeset	447 ## @item Octave:unimplemented-matlab-functionality
7ea82a190029 Add new warning ID "Octave:unimplemented-matlab-functionality". Rik <rik@octave.org> parents: 28279 diff changeset	448 ## If the @code{Octave:unimplemented-matlab-functionality} warning is enabled,
7ea82a190029 Add new warning ID "Octave:unimplemented-matlab-functionality". Rik <rik@octave.org> parents: 28279 diff changeset	449 ## a warning is printed when a @sc{matlab} code construct is used which the
7ea82a190029 Add new warning ID "Octave:unimplemented-matlab-functionality". Rik <rik@octave.org> parents: 28279 diff changeset	450 ## Octave interpreter parses as valid, but for which Octave does not yet
7ea82a190029 Add new warning ID "Octave:unimplemented-matlab-functionality". Rik <rik@octave.org> parents: 28279 diff changeset	451 ## implement the functionality.
7ea82a190029 Add new warning ID "Octave:unimplemented-matlab-functionality". Rik <rik@octave.org> parents: 28279 diff changeset	452 ## By default, the @code{Octave:unimplemented-matlab-functionality} warning is
7ea82a190029 Add new warning ID "Octave:unimplemented-matlab-functionality". Rik <rik@octave.org> parents: 28279 diff changeset	453 ## enabled.
7ea82a190029 Add new warning ID "Octave:unimplemented-matlab-functionality". Rik <rik@octave.org> parents: 28279 diff changeset	454 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	455 ## @item Octave:variable-switch-label
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	456 ## If the @code{Octave:variable-switch-label} warning is enabled, Octave
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	457 ## will print a warning if a switch label is not a constant or constant
13841 0a158dbdb04a Remove 3 unused warning ids Rik <octave@nomad.inbox5.com> parents: 12845 diff changeset	458 ## expression.
0a158dbdb04a Remove 3 unused warning ids Rik <octave@nomad.inbox5.com> parents: 12845 diff changeset	459 ## By default, the @code{Octave:variable-switch-label} warning is disabled.
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	460 ## @end table
17170 d6499c14021c doc: Periodic grammarcheck of documentation. Rik <rik@octave.org> parents: 17097 diff changeset	461 ##
d6499c14021c doc: Periodic grammarcheck of documentation. Rik <rik@octave.org> parents: 17097 diff changeset	462
8673 9e0f0a7bf858 warning_ids.m: make it a function that just calls help John W. Eaton <jwe@octave.org> parents: 8325 diff changeset	463 function warning_ids ()
9e0f0a7bf858 warning_ids.m: make it a function that just calls help John W. Eaton <jwe@octave.org> parents: 8325 diff changeset	464 help ("warning_ids");
9e0f0a7bf858 warning_ids.m: make it a function that just calls help John W. Eaton <jwe@octave.org> parents: 8325 diff changeset	465 endfunction
12845 29d4b27e485d Remove warning_ids.m from test statistics. Rik <octave@nomad.inbox5.com> parents: 12576 diff changeset	466
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	467
32058 e242124f1240 Overhaul input validation of sparse() function. Rik <rik@octave.org> parents: 31706 diff changeset	468 ## Mark file as tested. No tests needed for a documentation m-file.
12845 29d4b27e485d Remove warning_ids.m from test statistics. Rik <octave@nomad.inbox5.com> parents: 12576 diff changeset	469 %!assert (1)

Mercurial > octave

annotate scripts/help/warning_ids.m @ 32058:e242124f1240