octave: scripts/help/warning

annotate scripts/help/warning_ids.m @ 21993:a937963aacc9

* warning_ids.m: Doc fix for array-as-logical.

author	John W. Eaton <jwe@octave.org>
date	Wed, 29 Jun 2016 11:56:42 -0400
parents	efce657ceb86
children	bac0d6f07a3e

rev	line source
19697 4197fc428c7d maint: Update copyright notices for 2015. John W. Eaton <jwe@octave.org> parents: 19576 diff changeset	1 ## Copyright (C) 2006-2015 John W. Eaton
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6555 diff changeset	2 ##
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6555 diff changeset	3 ## This file is part of Octave.
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6555 diff changeset	4 ##
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6555 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: 6555 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: 6555 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: 6555 diff changeset	8 ## your option) any later version.
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6555 diff changeset	9 ##
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6555 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: 6555 diff changeset	11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6555 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: 6555 diff changeset	13 ## General Public License for more details.
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 ## 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	16 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6555 diff changeset	17 ## <http://www.gnu.org/licenses/>.
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6555 diff changeset	18
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	19 ## -- texinfo --
14119 94e2a76f1e5a doc: Final grammarcheck and spellcheck before 3.6.0 release. Rik <octave@nomad.inbox5.com> parents: 14116 diff changeset	20 ## @cindex warning ids
14366 b76f0740940e doc: Periodic grammar check of documentation. Rik <octave@nomad.inbox5.com> parents: 14363 diff changeset	21 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	22 ## @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	23 ## @item Octave:abbreviated-property-match
4aadd3e2c5bc warning_ids.m: Add missing warnings to list. They are not documented. Rik <octave@nomad.inbox5.com> parents: 13841 diff changeset	24 ## 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	25 ##
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	26 ## @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	27 ## 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	28 ## Octave will warn when an array of size greater than 1x1 is used
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	29 ## as a truth value in an if, while or until statement.
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	30 ## 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	31 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	32 ## @item Octave:array-to-scalar
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	33 ## 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	34 ## 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	35 ## attempted.
0a158dbdb04a Remove 3 unused warning ids Rik <octave@nomad.inbox5.com> parents: 12845 diff changeset	36 ## 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	37 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	38 ## @item Octave:array-to-vector
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	39 ## 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	40 ## 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	41 ## attempted.
0a158dbdb04a Remove 3 unused warning ids Rik <octave@nomad.inbox5.com> parents: 12845 diff changeset	42 ## 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	43 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	44 ## @item Octave:assign-as-truth-value
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	45 ## If the @code{Octave:assign-as-truth-value} warning is
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	46 ## 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	47 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	48 ## @example
9051 1bf0ce0930be Grammar check TexInfo in all .m files Rik <rdrider0-list@yahoo.com> parents: 9039 diff changeset	49 ## @group
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	50 ## if (s = t)
9039 51dc9691f23f Cleanup documentation files errors.texi, debug.texi, io.texi Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	51 ## @dots{}
9051 1bf0ce0930be Grammar check TexInfo in all .m files Rik <rdrider0-list@yahoo.com> parents: 9039 diff changeset	52 ## @end group
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	53 ## @end example
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	54 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	55 ## @noindent
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	56 ## 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	57 ## was to write
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	58 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	59 ## @example
9051 1bf0ce0930be Grammar check TexInfo in all .m files Rik <rdrider0-list@yahoo.com> parents: 9039 diff changeset	60 ## @group
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	61 ## if (s == t)
9039 51dc9691f23f Cleanup documentation files errors.texi, debug.texi, io.texi Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	62 ## @dots{}
9051 1bf0ce0930be Grammar check TexInfo in all .m files Rik <rdrider0-list@yahoo.com> parents: 9039 diff changeset	63 ## @end group
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	64 ## @end example
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	65 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	66 ## @noindent
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	67 ## instead.
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	68 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	69 ## 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	70 ## 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	71 ## 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	72 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	73 ## @example
9051 1bf0ce0930be Grammar check TexInfo in all .m files Rik <rdrider0-list@yahoo.com> parents: 9039 diff changeset	74 ## @group
14327 4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	75 ## while (c = getc ())
9039 51dc9691f23f Cleanup documentation files errors.texi, debug.texi, io.texi Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	76 ## @dots{}
9051 1bf0ce0930be Grammar check TexInfo in all .m files Rik <rdrider0-list@yahoo.com> parents: 9039 diff changeset	77 ## @end group
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	78 ## @end example
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	79 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	80 ## @noindent
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	81 ## 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	82 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	83 ## 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	84 ## disabling the @code{Octave:assign-as-truth-value} warning,
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	85 ## 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	86 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	87 ## @example
9051 1bf0ce0930be Grammar check TexInfo in all .m files Rik <rdrider0-list@yahoo.com> parents: 9039 diff changeset	88 ## @group
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	89 ## 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	90 ## @dots{}
9051 1bf0ce0930be Grammar check TexInfo in all .m files Rik <rdrider0-list@yahoo.com> parents: 9039 diff changeset	91 ## @end group
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	92 ## @end example
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	93 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	94 ## @noindent
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	95 ## slip by.
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	96 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	97 ## 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	98 ## 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	99 ## previous example as
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	100 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	101 ## @example
9051 1bf0ce0930be Grammar check TexInfo in all .m files Rik <rdrider0-list@yahoo.com> parents: 9039 diff changeset	102 ## @group
14327 4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	103 ## while ((c = getc ()))
9039 51dc9691f23f Cleanup documentation files errors.texi, debug.texi, io.texi Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	104 ## @dots{}
9051 1bf0ce0930be Grammar check TexInfo in all .m files Rik <rdrider0-list@yahoo.com> parents: 9039 diff changeset	105 ## @end group
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	106 ## @end example
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	107 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	108 ## @noindent
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	109 ## 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	110 ## allowing Octave to warn about other assignments used in conditional
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	111 ## contexts.
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	112 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	113 ## 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	114 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	115 ## @item Octave:associativity-change
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	116 ## If the @code{Octave:associativity-change} warning is
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	117 ## enabled, Octave will warn about possible changes in the meaning of
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	118 ## some code due to changes in associativity for some operators.
9051 1bf0ce0930be Grammar check TexInfo in all .m files Rik <rdrider0-list@yahoo.com> parents: 9039 diff changeset	119 ## Associativity changes have typically been made for @sc{matlab}
13841 0a158dbdb04a Remove 3 unused warning ids Rik <octave@nomad.inbox5.com> parents: 12845 diff changeset	120 ## compatibility.
0a158dbdb04a Remove 3 unused warning ids Rik <octave@nomad.inbox5.com> parents: 12845 diff changeset	121 ## By default, the @code{Octave:associativity-change} warning is enabled.
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	122 ##
12486 32279948bf3b Document the Octave:autoload-relative-file-name warning. Thomas Weber <tweber@debian.org> parents: 12477 diff changeset	123 ## @item Octave:autoload-relative-file-name
32279948bf3b Document the Octave:autoload-relative-file-name warning. Thomas Weber <tweber@debian.org> parents: 12477 diff changeset	124 ## 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	125 ## 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	126 ## 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	127 ## 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	128 ## 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	129 ## 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	130 ## enabled.
12486 32279948bf3b Document the Octave:autoload-relative-file-name warning. Thomas Weber <tweber@debian.org> parents: 12477 diff changeset	131 ##
13842 4aadd3e2c5bc warning_ids.m: Add missing warnings to list. They are not documented. Rik <octave@nomad.inbox5.com> parents: 13841 diff changeset	132 ## @item Octave:built-in-variable-assignment
4aadd3e2c5bc warning_ids.m: Add missing warnings to list. They are not documented. Rik <octave@nomad.inbox5.com> parents: 13841 diff changeset	133 ## By default, the @code{Octave:built-in-variable-assignment} warning is
4aadd3e2c5bc warning_ids.m: Add missing warnings to list. They are not documented. Rik <octave@nomad.inbox5.com> parents: 13841 diff changeset	134 ## enabled.
4aadd3e2c5bc warning_ids.m: Add missing warnings to list. They are not documented. Rik <octave@nomad.inbox5.com> parents: 13841 diff changeset	135 ##
21654 a0ebc922fd52 Add "facenormals" and "normalsmode" to "surface" and "patch" (bug #47791) mmuetzel <markus.muetzel@gmx.de>* parents: 21546 diff changeset	136 ## @item Octave:deprecated-function
a0ebc922fd52 Add "facenormals" and "normalsmode" to "surface" and "patch" (bug #47791) mmuetzel <markus.muetzel@gmx.de>* parents: 21546 diff changeset	137 ## 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	138 ## 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	139 ## 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	140 ## 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	141 ##
15605 80a4ded6b89c warning_ids.m: Add 2 missing warning IDs to documentation. Rik <rik@octave.org> parents: 14366 diff changeset	142 ## @item Octave:deprecated-keyword
80a4ded6b89c warning_ids.m: Add 2 missing warning IDs to documentation. Rik <rik@octave.org> parents: 14366 diff changeset	143 ## 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	144 ## 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	145 ## scheduled for removal from Octave.
80a4ded6b89c warning_ids.m: Add 2 missing warning IDs to documentation. Rik <rik@octave.org> parents: 14366 diff changeset	146 ## 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	147 ##
21654 a0ebc922fd52 Add "facenormals" and "normalsmode" to "surface" and "patch" (bug #47791) mmuetzel <markus.muetzel@gmx.de>* parents: 21546 diff changeset	148 ## @item Octave:deprecated-property
a0ebc922fd52 Add "facenormals" and "normalsmode" to "surface" and "patch" (bug #47791) mmuetzel <markus.muetzel@gmx.de>* parents: 21546 diff changeset	149 ## 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	150 ## 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	151 ## 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	152 ## 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	153 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	154 ## @item Octave:divide-by-zero
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	155 ## If the @code{Octave:divide-by-zero} warning is enabled, a
13841 0a158dbdb04a Remove 3 unused warning ids Rik <octave@nomad.inbox5.com> parents: 12845 diff changeset	156 ## warning is issued when Octave encounters a division by zero.
0a158dbdb04a Remove 3 unused warning ids Rik <octave@nomad.inbox5.com> parents: 12845 diff changeset	157 ## By default, the @code{Octave:divide-by-zero} warning is enabled.
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	158 ##
13842 4aadd3e2c5bc warning_ids.m: Add missing warnings to list. They are not documented. Rik <octave@nomad.inbox5.com> parents: 13841 diff changeset	159 ## @item Octave:fopen-file-in-path
4aadd3e2c5bc warning_ids.m: Add missing warnings to list. They are not documented. Rik <octave@nomad.inbox5.com> parents: 13841 diff changeset	160 ## By default, the @code{Octave:fopen-file-in-path} 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	161 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	162 ## @item Octave:function-name-clash
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	163 ## 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	164 ## 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	165 ## 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	166 ## 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	167 ## 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	168 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	169 ## @item Octave:future-time-stamp
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	170 ## 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	171 ## 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	172 ## that is in the future.
0a158dbdb04a Remove 3 unused warning ids Rik <octave@nomad.inbox5.com> parents: 12845 diff changeset	173 ## 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	174 ##
13842 4aadd3e2c5bc warning_ids.m: Add missing warnings to list. They are not documented. Rik <octave@nomad.inbox5.com> parents: 13841 diff changeset	175 ## @item Octave:glyph-render
4aadd3e2c5bc warning_ids.m: Add missing warnings to list. They are not documented. Rik <octave@nomad.inbox5.com> parents: 13841 diff changeset	176 ## 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	177 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	178 ## @item Octave:imag-to-real
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	179 ## 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	180 ## printed for implicit conversions of complex numbers to real numbers.
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	181 ## 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	182 ##
19852 e9a0bd0b125c Rename 'matlab-incompatible' warning to 'language-extension'. Carnë Draug <carandraug@octave.org> parents: 19851 diff changeset	183 ## @item Octave:language-extension
e9a0bd0b125c Rename 'matlab-incompatible' warning to 'language-extension'. Carnë Draug <carandraug@octave.org> parents: 19851 diff changeset	184 ## 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	185 ## 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	186 ## 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	187 ## The @option{--traditional} or @option{--braindead} startup options for
e51473fdb622 doc: Periodic grammarcheck of documentation. Rik <rik@octave.org> parents: 19852 diff changeset	188 ## 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	189 ##
13842 4aadd3e2c5bc warning_ids.m: Add missing warnings to list. They are not documented. Rik <octave@nomad.inbox5.com> parents: 13841 diff changeset	190 ## @item Octave:load-file-in-path
4aadd3e2c5bc warning_ids.m: Add missing warnings to list. They are not documented. Rik <octave@nomad.inbox5.com> parents: 13841 diff changeset	191 ## By default, the @code{Octave:load-file-in-path} 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	192 ##
4aadd3e2c5bc warning_ids.m: Add missing warnings to list. They are not documented. Rik <octave@nomad.inbox5.com> parents: 13841 diff changeset	193 ## @item Octave:logical-conversion
4aadd3e2c5bc warning_ids.m: Add missing warnings to list. They are not documented. Rik <octave@nomad.inbox5.com> parents: 13841 diff changeset	194 ## 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	195 ##
4aadd3e2c5bc warning_ids.m: Add missing warnings to list. They are not documented. Rik <octave@nomad.inbox5.com> parents: 13841 diff changeset	196 ## @item Octave:missing-glyph
4aadd3e2c5bc warning_ids.m: Add missing warnings to list. They are not documented. Rik <octave@nomad.inbox5.com> parents: 13841 diff changeset	197 ## 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	198 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	199 ## @item Octave:missing-semicolon
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	200 ## If the @code{Octave:missing-semicolon} warning is enabled, Octave
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	201 ## 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	202 ## semicolons.
0a158dbdb04a Remove 3 unused warning ids Rik <octave@nomad.inbox5.com> parents: 12845 diff changeset	203 ## 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	204 ##
0a158dbdb04a Remove 3 unused warning ids Rik <octave@nomad.inbox5.com> parents: 12845 diff changeset	205 ## @item Octave:mixed-string-concat
0a158dbdb04a Remove 3 unused warning ids Rik <octave@nomad.inbox5.com> parents: 12845 diff changeset	206 ## 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	207 ## 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	208 ## 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	209 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	210 ## @item Octave:neg-dim-as-zero
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	211 ## 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	212 ## for expressions like
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	213 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	214 ## @example
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	215 ## eye (-1)
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	216 ## @end example
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	217 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	218 ## @noindent
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	219 ## 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	220 ##
13842 4aadd3e2c5bc warning_ids.m: Add missing warnings to list. They are not documented. Rik <octave@nomad.inbox5.com> parents: 13841 diff changeset	221 ## @item Octave:nested-functions-coerced
4aadd3e2c5bc warning_ids.m: Add missing warnings to list. They are not documented. Rik <octave@nomad.inbox5.com> parents: 13841 diff changeset	222 ## By default, the @code{Octave:nested-functions-coerced} 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	223 ##
4aadd3e2c5bc warning_ids.m: Add missing warnings to list. They are not documented. Rik <octave@nomad.inbox5.com> parents: 13841 diff changeset	224 ## @item Octave:noninteger-range-as-index
4aadd3e2c5bc warning_ids.m: Add missing warnings to list. They are not documented. Rik <octave@nomad.inbox5.com> parents: 13841 diff changeset	225 ## 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	226 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	227 ## @item Octave:num-to-str
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	228 ## If the @code{Octave:num-to-str} warning is enable, a warning is
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	229 ## printed for implicit conversions of numbers to their ASCII character
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	230 ## 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	231 ## 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	232 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	233 ## @example
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	234 ## @group
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	235 ## [ "f", 111, 111 ]
14327 4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	236 ## @result{} "foo"
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	237 ## @end group
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	238 ## @end example
10821 693e22af08ae Grammarcheck documentation of m-files Rik <octave@nomad.inbox5.com> parents: 9051 diff changeset	239 ##
10846 a4f482e66b65 Grammarcheck more of the documentation. Rik <octave@nomad.inbox5.com> parents: 10821 diff changeset	240 ## @noindent
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	241 ## 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	242 ## 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	243 ##
12477 d1466d956d17 Add a warning description for Matlab-style short-circuiting Jordi Gutiérrez Hermoso <jordigh@gmail.com> parents: 11587 diff changeset	244 ## @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	245 ## 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	246 ## 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	247 ## operators @code{&} and @code{\|} inside @code{if} or @code{while}
12575 d0b799dafede Grammarcheck files for 3.4.1 release. Rik <octave@nomad.inbox5.com> parents: 12486 diff changeset	248 ## conditions. They normally never short circuit, but @sc{matlab} always
d0b799dafede Grammarcheck files for 3.4.1 release. Rik <octave@nomad.inbox5.com> parents: 12486 diff changeset	249 ## short circuits if any logical operators are used in a condition. You
12477 d1466d956d17 Add a warning description for Matlab-style short-circuiting Jordi Gutiérrez Hermoso <jordigh@gmail.com> parents: 11587 diff changeset	250 ## can turn on the option
d1466d956d17 Add a warning description for Matlab-style short-circuiting Jordi Gutiérrez Hermoso <jordigh@gmail.com> parents: 11587 diff changeset	251 ##
d1466d956d17 Add a warning description for Matlab-style short-circuiting Jordi Gutiérrez Hermoso <jordigh@gmail.com> parents: 11587 diff changeset	252 ## @example
d1466d956d17 Add a warning description for Matlab-style short-circuiting Jordi Gutiérrez Hermoso <jordigh@gmail.com> parents: 11587 diff changeset	253 ## @group
14327 4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	254 ## do_braindead_shortcircuit_evaluation (1)
12477 d1466d956d17 Add a warning description for Matlab-style short-circuiting Jordi Gutiérrez Hermoso <jordigh@gmail.com> parents: 11587 diff changeset	255 ## @end group
d1466d956d17 Add a warning description for Matlab-style short-circuiting Jordi Gutiérrez Hermoso <jordigh@gmail.com> parents: 11587 diff changeset	256 ## @end example
d1466d956d17 Add a warning description for Matlab-style short-circuiting Jordi Gutiérrez Hermoso <jordigh@gmail.com> parents: 11587 diff changeset	257 ##
d1466d956d17 Add a warning description for Matlab-style short-circuiting Jordi Gutiérrez Hermoso <jordigh@gmail.com> parents: 11587 diff changeset	258 ## @noindent
d1466d956d17 Add a warning description for Matlab-style short-circuiting Jordi Gutiérrez Hermoso <jordigh@gmail.com> parents: 11587 diff changeset	259 ## if you would like to enable this short-circuit evaluation in
12575 d0b799dafede Grammarcheck files for 3.4.1 release. Rik <octave@nomad.inbox5.com> parents: 12486 diff changeset	260 ## Octave. Note that the @code{&&} and @code{\|\|} operators always short
d0b799dafede Grammarcheck files for 3.4.1 release. Rik <octave@nomad.inbox5.com> parents: 12486 diff changeset	261 ## circuit in both Octave and @sc{matlab}, so it's only necessary to
15605 80a4ded6b89c warning_ids.m: Add 2 missing warning IDs to documentation. Rik <rik@octave.org> parents: 14366 diff changeset	262 ## enable @sc{matlab}-style short-circuiting if it's too arduous to modify
12576 a1e386b9ef4b Spellcheck documentation for 3.4.1 release. Rik <octave@nomad.inbox5.com> parents: 12575 diff changeset	263 ## existing code that relies on this behavior.
13841 0a158dbdb04a Remove 3 unused warning ids Rik <octave@nomad.inbox5.com> parents: 12845 diff changeset	264 ## 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	265 ## is enabled.
12477 d1466d956d17 Add a warning description for Matlab-style short-circuiting Jordi Gutiérrez Hermoso <jordigh@gmail.com> parents: 11587 diff changeset	266 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	267 ## @item Octave:precedence-change
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	268 ## If the @code{Octave:precedence-change} warning is enabled, Octave
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	269 ## will warn about possible changes in the meaning of some code due to
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	270 ## changes in precedence for some operators. Precedence changes have
13841 0a158dbdb04a Remove 3 unused warning ids Rik <octave@nomad.inbox5.com> parents: 12845 diff changeset	271 ## typically been made for @sc{matlab} compatibility.
0a158dbdb04a Remove 3 unused warning ids Rik <octave@nomad.inbox5.com> parents: 12845 diff changeset	272 ## By default, the @code{Octave:precedence-change} warning is enabled.
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	273 ##
13842 4aadd3e2c5bc warning_ids.m: Add missing warnings to list. They are not documented. Rik <octave@nomad.inbox5.com> parents: 13841 diff changeset	274 ## @item Octave:recursive-path-search
4aadd3e2c5bc warning_ids.m: Add missing warnings to list. They are not documented. Rik <octave@nomad.inbox5.com> parents: 13841 diff changeset	275 ## 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	276 ##
15605 80a4ded6b89c warning_ids.m: Add 2 missing warning IDs to documentation. Rik <rik@octave.org> parents: 14366 diff changeset	277 ## @item Octave:remove-init-dir
80a4ded6b89c warning_ids.m: Add 2 missing warning IDs to documentation. Rik <rik@octave.org> parents: 14366 diff changeset	278 ## 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	279 ## 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	280 ## 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	281 ## @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	282 ## 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	283 ## Octave unworkable.
80a4ded6b89c warning_ids.m: Add 2 missing warning IDs to documentation. Rik <rik@octave.org> parents: 14366 diff changeset	284 ## 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	285 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	286 ## @item Octave:reload-forces-clear
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	287 ## 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	288 ## 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	289 ## 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	290 ## 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	291 ## functions that it is forced to clear.
0a158dbdb04a Remove 3 unused warning ids Rik <octave@nomad.inbox5.com> parents: 12845 diff changeset	292 ## 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	293 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	294 ## @item Octave:resize-on-range-error
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	295 ## If the @code{Octave:resize-on-range-error} warning is enabled, print a
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	296 ## warning when a matrix is resized by an indexed assignment with
13841 0a158dbdb04a Remove 3 unused warning ids Rik <octave@nomad.inbox5.com> parents: 12845 diff changeset	297 ## indices outside the current bounds.
0a158dbdb04a Remove 3 unused warning ids Rik <octave@nomad.inbox5.com> parents: 12845 diff changeset	298 ## By default, the ## @code{Octave:resize-on-range-error} warning is disabled.
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	299 ##
5794 1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5781 diff changeset	300 ## @item Octave:separator-insert
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5781 diff changeset	301 ## Print warning if commas or semicolons might be inserted
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5781 diff changeset	302 ## automatically in literal matrices.
13841 0a158dbdb04a Remove 3 unused warning ids Rik <octave@nomad.inbox5.com> parents: 12845 diff changeset	303 ## 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	304 ##
13842 4aadd3e2c5bc warning_ids.m: Add missing warnings to list. They are not documented. Rik <octave@nomad.inbox5.com> parents: 13841 diff changeset	305 ## @item Octave:shadowed-function
4aadd3e2c5bc warning_ids.m: Add missing warnings to list. They are not documented. Rik <octave@nomad.inbox5.com> parents: 13841 diff changeset	306 ## 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	307 ##
5794 1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5781 diff changeset	308 ## @item Octave:single-quote-string
8325 b93ac0586e4b spelling corrections Brian Gough<bjg@network-theory.co.uk> parents: 7017 diff changeset	309 ## 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	310 ## string constant.
13841 0a158dbdb04a Remove 3 unused warning ids Rik <octave@nomad.inbox5.com> parents: 12845 diff changeset	311 ## 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	312 ##
19576 e97c63531e76 doc: Periodic grammarcheck of documentation. Rik <rik@octave.org> parents: 19408 diff changeset	313 ## @item Octave:nearly-singular-matrix
19408 a0c7001cf1a8 consistent messages and IDs for singular matrix warnings John W. Eaton <jwe@octave.org> parents: 19192 diff changeset	314 ## @itemx Octave:singular-matrix
a0c7001cf1a8 consistent messages and IDs for singular matrix warnings John W. Eaton <jwe@octave.org> parents: 19192 diff changeset	315 ## By default, the @code{Octave:nearly-singular-matrix} and
a0c7001cf1a8 consistent messages and IDs for singular matrix warnings John W. Eaton <jwe@octave.org> parents: 19192 diff changeset	316 ## @code{Octave:singular-matrix} warnings are enabled.
13842 4aadd3e2c5bc warning_ids.m: Add missing warnings to list. They are not documented. Rik <octave@nomad.inbox5.com> parents: 13841 diff changeset	317 ##
4aadd3e2c5bc warning_ids.m: Add missing warnings to list. They are not documented. Rik <octave@nomad.inbox5.com> parents: 13841 diff changeset	318 ## @item Octave:sqrtm:SingularMatrix
4aadd3e2c5bc warning_ids.m: Add missing warnings to list. They are not documented. Rik <octave@nomad.inbox5.com> parents: 13841 diff changeset	319 ## 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	320 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	321 ## @item Octave:str-to-num
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	322 ## If the @code{Octave:str-to-num} warning is enabled, a warning is printed
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	323 ## for implicit conversions of strings to their numeric ASCII equivalents.
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	324 ## For example,
10821 693e22af08ae Grammarcheck documentation of m-files Rik <octave@nomad.inbox5.com> parents: 9051 diff changeset	325 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	326 ## @example
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	327 ## @group
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	328 ## "abc" + 0
14327 4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	329 ## @result{} 97 98 99
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	330 ## @end group
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	331 ## @end example
10821 693e22af08ae Grammarcheck documentation of m-files Rik <octave@nomad.inbox5.com> parents: 9051 diff changeset	332 ##
10846 a4f482e66b65 Grammarcheck more of the documentation. Rik <octave@nomad.inbox5.com> parents: 10821 diff changeset	333 ## @noindent
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	334 ## 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	335 ## 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	336 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	337 ## @item Octave:undefined-return-values
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	338 ## If the @code{Octave:undefined-return-values} warning is disabled,
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	339 ## print a warning if a function does not define all the values in
13841 0a158dbdb04a Remove 3 unused warning ids Rik <octave@nomad.inbox5.com> parents: 12845 diff changeset	340 ## the return list which are expected.
0a158dbdb04a Remove 3 unused warning ids Rik <octave@nomad.inbox5.com> parents: 12845 diff changeset	341 ## By default, the @code{Octave:undefined-return-values} warning is enabled.
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	342 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	343 ## @item Octave:variable-switch-label
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	344 ## 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	345 ## 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	346 ## expression.
0a158dbdb04a Remove 3 unused warning ids Rik <octave@nomad.inbox5.com> parents: 12845 diff changeset	347 ## 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	348 ## @end table
17170 d6499c14021c doc: Periodic grammarcheck of documentation. Rik <rik@octave.org> parents: 17097 diff changeset	349 ##
d6499c14021c doc: Periodic grammarcheck of documentation. Rik <rik@octave.org> parents: 17097 diff changeset	350
8673 9e0f0a7bf858 warning_ids.m: make it a function that just calls help John W. Eaton <jwe@octave.org> parents: 8325 diff changeset	351 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	352 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	353 endfunction
12845 29d4b27e485d Remove warning_ids.m from test statistics. Rik <octave@nomad.inbox5.com> parents: 12576 diff changeset	354
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	355
19192 8a8a7bc2a09d Improve docstrings and mark documentation m-files as tested in miscellaneous/ dir. Rik <rik@octave.org> parents: 17744 diff changeset	356 ## Mark file as being tested. No real test needed for a documentation .m file
12845 29d4b27e485d Remove warning_ids.m from test statistics. Rik <octave@nomad.inbox5.com> parents: 12576 diff changeset	357 %!assert (1)
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	358

Mercurial > octave

annotate scripts/help/warning_ids.m @ 21993:a937963aacc9