Mercurial > octave

annotate scripts/help/warning_ids.m @ 26043:5cef57130cb9

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: grammar check m-files in scripts/ directory. * warning_ids.m, ishermitian.m, open.m, fzero.m, light.m, __pltopt__.m, print.m, __add_default_menu__.m, savefig.m: grammar check docstrings.
author Rik <rik@octave.org>
date Thu, 08 Nov 2018 22:02:43 -0800
parents e9f107d31799
children 00f796120a6d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
25054
6652d3823428 maint: Update copyright dates in all source files.
John W. Eaton <jwe@octave.org>
parents: 25037
diff changeset
1 ## Copyright (C) 2006-2018 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 ##
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 24473
diff changeset
5 ## 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
6 ## 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
7 ## 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
8 ## (at your option) any later version.
7016
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
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22323
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22323
diff changeset
13 ## GNU General Public License for more details.
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 ## 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
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 24473
diff changeset
17 ## <https://www.gnu.org/licenses/>.
7016
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 ##
23994
8785b3717140 Issue a warning if addpath() called for a +pkg directory (bug #45410).
Rik <rik@octave.org>
parents: 23918
diff changeset
26 ## @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
27 ## 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
28 ## 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
29 ## 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
30 ## 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
31 ## 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
32 ##
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
33 ## @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
34 ## 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
35 ## 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
36 ## 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
37 ## 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
38 ##
5781
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents:
diff changeset
39 ## @item Octave:array-to-scalar
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents:
diff changeset
40 ## 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
41 ## 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
42 ## attempted.
0a158dbdb04a Remove 3 unused warning ids
Rik <octave@nomad.inbox5.com>
parents: 12845
diff changeset
43 ## 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
44 ##
5781
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents:
diff changeset
45 ## @item Octave:array-to-vector
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents:
diff changeset
46 ## 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
47 ## 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
48 ## attempted.
0a158dbdb04a Remove 3 unused warning ids
Rik <octave@nomad.inbox5.com>
parents: 12845
diff changeset
49 ## 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
50 ##
5781
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents:
diff changeset
51 ## @item Octave:assign-as-truth-value
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents:
diff changeset
52 ## If the @code{Octave:assign-as-truth-value} warning is
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents:
diff changeset
53 ## 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
54 ##
5781
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents:
diff changeset
55 ## @example
9051
1bf0ce0930be Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents: 9039
diff changeset
56 ## @group
5781
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents:
diff changeset
57 ## if (s = t)
9039
51dc9691f23f Cleanup documentation files errors.texi, debug.texi, io.texi
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
58 ## @dots{}
9051
1bf0ce0930be Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents: 9039
diff changeset
59 ## @end group
5781
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents:
diff changeset
60 ## @end example
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
61 ##
5781
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents:
diff changeset
62 ## @noindent
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents:
diff changeset
63 ## 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
64 ## was to write
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 ## @example
9051
1bf0ce0930be Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents: 9039
diff changeset
67 ## @group
5781
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents:
diff changeset
68 ## if (s == t)
9039
51dc9691f23f Cleanup documentation files errors.texi, debug.texi, io.texi
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
69 ## @dots{}
9051
1bf0ce0930be Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents: 9039
diff changeset
70 ## @end group
5781
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents:
diff changeset
71 ## @end example
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 ## @noindent
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents:
diff changeset
74 ## instead.
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
75 ##
5781
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents:
diff changeset
76 ## 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
77 ## 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
78 ## 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
79 ##
5781
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents:
diff changeset
80 ## @example
9051
1bf0ce0930be Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents: 9039
diff changeset
81 ## @group
14327
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
82 ## while (c = getc ())
9039
51dc9691f23f Cleanup documentation files errors.texi, debug.texi, io.texi
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
83 ## @dots{}
9051
1bf0ce0930be Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents: 9039
diff changeset
84 ## @end group
5781
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents:
diff changeset
85 ## @end example
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 ## @noindent
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents:
diff changeset
88 ## 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
89 ##
5781
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents:
diff changeset
90 ## 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
91 ## disabling the @code{Octave:assign-as-truth-value} warning,
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents:
diff changeset
92 ## 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
93 ##
5781
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents:
diff changeset
94 ## @example
9051
1bf0ce0930be Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents: 9039
diff changeset
95 ## @group
5781
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents:
diff changeset
96 ## 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
97 ## @dots{}
9051
1bf0ce0930be Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents: 9039
diff changeset
98 ## @end group
5781
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents:
diff changeset
99 ## @end example
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 ## @noindent
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents:
diff changeset
102 ## slip by.
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
103 ##
5781
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents:
diff changeset
104 ## 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
105 ## 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
106 ## previous example as
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 ## @example
9051
1bf0ce0930be Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents: 9039
diff changeset
109 ## @group
14327
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
110 ## while ((c = getc ()))
9039
51dc9691f23f Cleanup documentation files errors.texi, debug.texi, io.texi
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
111 ## @dots{}
9051
1bf0ce0930be Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents: 9039
diff changeset
112 ## @end group
5781
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents:
diff changeset
113 ## @end example
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 ## @noindent
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents:
diff changeset
116 ## 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
117 ## allowing Octave to warn about other assignments used in conditional
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents:
diff changeset
118 ## contexts.
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
119 ##
5781
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents:
diff changeset
120 ## 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
121 ##
5781
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents:
diff changeset
122 ## @item Octave:associativity-change
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents:
diff changeset
123 ## If the @code{Octave:associativity-change} warning is
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents:
diff changeset
124 ## 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
125 ## 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
126 ## 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
127 ## compatibility.
0a158dbdb04a Remove 3 unused warning ids
Rik <octave@nomad.inbox5.com>
parents: 12845
diff changeset
128 ## 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
129 ##
12486
32279948bf3b Document the Octave:autoload-relative-file-name warning.
Thomas Weber <tweber@debian.org>
parents: 12477
diff changeset
130 ## @item Octave:autoload-relative-file-name
32279948bf3b Document the Octave:autoload-relative-file-name warning.
Thomas Weber <tweber@debian.org>
parents: 12477
diff changeset
131 ## 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
132 ## 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
133 ## 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
134 ## 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
135 ## 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
136 ## 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
137 ## enabled.
12486
32279948bf3b Document the Octave:autoload-relative-file-name warning.
Thomas Weber <tweber@debian.org>
parents: 12477
diff changeset
138 ##
13842
4aadd3e2c5bc warning_ids.m: Add missing warnings to list. They are not documented.
Rik <octave@nomad.inbox5.com>
parents: 13841
diff changeset
139 ## @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
140 ## 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
141 ## enabled.
4aadd3e2c5bc warning_ids.m: Add missing warnings to list. They are not documented.
Rik <octave@nomad.inbox5.com>
parents: 13841
diff changeset
142 ##
21654
a0ebc922fd52 Add "facenormals" and "*normalsmode" to "surface" and "patch" (bug #47791)
mmuetzel <markus.muetzel@gmx.de>
parents: 21546
diff changeset
143 ## @item Octave:deprecated-function
a0ebc922fd52 Add "facenormals" and "*normalsmode" to "surface" and "patch" (bug #47791)
mmuetzel <markus.muetzel@gmx.de>
parents: 21546
diff changeset
144 ## 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
145 ## 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
146 ## 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
147 ## 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
148 ##
15605
80a4ded6b89c warning_ids.m: Add 2 missing warning IDs to documentation.
Rik <rik@octave.org>
parents: 14366
diff changeset
149 ## @item Octave:deprecated-keyword
80a4ded6b89c warning_ids.m: Add 2 missing warning IDs to documentation.
Rik <rik@octave.org>
parents: 14366
diff changeset
150 ## 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
151 ## 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
152 ## scheduled for removal from Octave.
80a4ded6b89c warning_ids.m: Add 2 missing warning IDs to documentation.
Rik <rik@octave.org>
parents: 14366
diff changeset
153 ## 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
154 ##
21654
a0ebc922fd52 Add "facenormals" and "*normalsmode" to "surface" and "patch" (bug #47791)
mmuetzel <markus.muetzel@gmx.de>
parents: 21546
diff changeset
155 ## @item Octave:deprecated-property
a0ebc922fd52 Add "facenormals" and "*normalsmode" to "surface" and "patch" (bug #47791)
mmuetzel <markus.muetzel@gmx.de>
parents: 21546
diff changeset
156 ## 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
157 ## 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
158 ## 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
159 ## 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
160 ##
5781
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents:
diff changeset
161 ## @item Octave:divide-by-zero
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents:
diff changeset
162 ## 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
163 ## 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
164 ## 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
165 ##
24334
d3d38a443df8 Add new warning ID "Octave:eigs:UnconvergedEigenvalues".
Rik <rik@octave.org>
parents: 24034
diff changeset
166 ## @item Octave:eigs:UnconvergedEigenvalues
d3d38a443df8 Add new warning ID "Octave:eigs:UnconvergedEigenvalues".
Rik <rik@octave.org>
parents: 24034
diff changeset
167 ## 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
168 ## 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
169 ## 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
170 ## 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
171 ## enabled.
d3d38a443df8 Add new warning ID "Octave:eigs:UnconvergedEigenvalues".
Rik <rik@octave.org>
parents: 24034
diff changeset
172 ##
24473
42d099b841aa erase.m: Add warning if a character array is used for PTN.
Rik <rik@octave.org>
parents: 24334
diff changeset
173 ## @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
174 ## 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
175 ## 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
176 ## 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
177 ## 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
178 ##
25179
3ae57b161ab4 doc: Document warning ID Octave:data-file-in-path (bug #53588)
Rik <rik@octave.org>
parents: 25054
diff changeset
179 ## @item Octave:data-file-in-path
3ae57b161ab4 doc: Document warning ID Octave:data-file-in-path (bug #53588)
Rik <rik@octave.org>
parents: 25054
diff changeset
180 ## If the @code{Octave:data-file-in-path} warning is enabled, a warning is
3ae57b161ab4 doc: Document warning ID Octave:data-file-in-path (bug #53588)
Rik <rik@octave.org>
parents: 25054
diff changeset
181 ## issued when Octave does not find the target of a file operation such as
3ae57b161ab4 doc: Document warning ID Octave:data-file-in-path (bug #53588)
Rik <rik@octave.org>
parents: 25054
diff changeset
182 ## @code{load} or @code{fopen} directly, but is able to locate the file in
3ae57b161ab4 doc: Document warning ID Octave:data-file-in-path (bug #53588)
Rik <rik@octave.org>
parents: 25054
diff changeset
183 ## Octave's search @code{path} for files. The warning could indicate that a
25183
e3d5c1def2c8 doc: fix remaining mention of old name for Octave:data-file-in-path (bug #53588)
Mike Miller <mtmiller@octave.org>
parents: 25179
diff changeset
184 ## different file target than the programmer intended is being used.
e3d5c1def2c8 doc: fix remaining mention of old name for Octave:data-file-in-path (bug #53588)
Mike Miller <mtmiller@octave.org>
parents: 25179
diff changeset
185 ## By default, the @code{Octave:data-file-in-path} 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
186 ##
5781
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents:
diff changeset
187 ## @item Octave:function-name-clash
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents:
diff changeset
188 ## 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
189 ## 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
190 ## 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
191 ## 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
192 ## 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
193 ##
5781
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents:
diff changeset
194 ## @item Octave:future-time-stamp
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents:
diff changeset
195 ## 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
196 ## 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
197 ## that is in the future.
0a158dbdb04a Remove 3 unused warning ids
Rik <octave@nomad.inbox5.com>
parents: 12845
diff changeset
198 ## 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
199 ##
13842
4aadd3e2c5bc warning_ids.m: Add missing warnings to list. They are not documented.
Rik <octave@nomad.inbox5.com>
parents: 13841
diff changeset
200 ## @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
201 ## 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
202 ##
5781
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents:
diff changeset
203 ## @item Octave:imag-to-real
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents:
diff changeset
204 ## 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
205 ## printed for implicit conversions of complex numbers to real numbers.
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents:
diff changeset
206 ## 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
207 ##
19852
e9a0bd0b125c Rename 'matlab-incompatible' warning to 'language-extension'.
Carnë Draug <carandraug@octave.org>
parents: 19851
diff changeset
208 ## @item Octave:language-extension
e9a0bd0b125c Rename 'matlab-incompatible' warning to 'language-extension'.
Carnë Draug <carandraug@octave.org>
parents: 19851
diff changeset
209 ## 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
210 ## 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
211 ## 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
212 ## The @option{--traditional} or @option{--braindead} startup options for
e51473fdb622 doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 19852
diff changeset
213 ## 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
214 ##
25720
e9f107d31799 warning_ids.m: Document new Octave:legacy-function warning.
Rik <rik@octave.org>
parents: 25579
diff changeset
215 ## @item Octave:legacy-function
e9f107d31799 warning_ids.m: Document new Octave:legacy-function warning.
Rik <rik@octave.org>
parents: 25579
diff changeset
216 ## 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
217 ## 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
218 ## 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
219 ## 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
220 ## @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
221 ## 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
222 ## 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
223 ##
13842
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:logical-conversion
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: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
226 ##
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
227 ## @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
228 ## 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
229 ## 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
230 ## 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
231 ## 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
232 ## 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
233 ##
13842
4aadd3e2c5bc warning_ids.m: Add missing warnings to list. They are not documented.
Rik <octave@nomad.inbox5.com>
parents: 13841
diff changeset
234 ## @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
235 ## 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
236 ##
5781
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents:
diff changeset
237 ## @item Octave:missing-semicolon
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents:
diff changeset
238 ## If the @code{Octave:missing-semicolon} warning is enabled, Octave
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents:
diff changeset
239 ## 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
240 ## semicolons.
0a158dbdb04a Remove 3 unused warning ids
Rik <octave@nomad.inbox5.com>
parents: 12845
diff changeset
241 ## 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
242 ##
0a158dbdb04a Remove 3 unused warning ids
Rik <octave@nomad.inbox5.com>
parents: 12845
diff changeset
243 ## @item Octave:mixed-string-concat
0a158dbdb04a Remove 3 unused warning ids
Rik <octave@nomad.inbox5.com>
parents: 12845
diff changeset
244 ## 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
245 ## 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
246 ## 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
247 ##
24963
2e4ed4250e52 warning_ids.m: alphabetic order nearly-singular-matrix
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents: 24534
diff changeset
248 ## @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
249 ## @itemx Octave:singular-matrix
2e4ed4250e52 warning_ids.m: alphabetic order nearly-singular-matrix
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents: 24534
diff changeset
250 ## 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
251 ## @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
252 ##
5781
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents:
diff changeset
253 ## @item Octave:neg-dim-as-zero
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents:
diff changeset
254 ## 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
255 ## for expressions like
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
256 ##
5781
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents:
diff changeset
257 ## @example
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents:
diff changeset
258 ## eye (-1)
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents:
diff changeset
259 ## @end example
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
260 ##
5781
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents:
diff changeset
261 ## @noindent
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents:
diff changeset
262 ## 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
263 ##
13842
4aadd3e2c5bc warning_ids.m: Add missing warnings to list. They are not documented.
Rik <octave@nomad.inbox5.com>
parents: 13841
diff changeset
264 ## @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
265 ## 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
266 ##
4aadd3e2c5bc warning_ids.m: Add missing warnings to list. They are not documented.
Rik <octave@nomad.inbox5.com>
parents: 13841
diff changeset
267 ## @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
268 ## 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
269 ##
5781
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents:
diff changeset
270 ## @item Octave:num-to-str
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents:
diff changeset
271 ## 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
272 ## printed for implicit conversions of numbers to their ASCII character
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents:
diff changeset
273 ## 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
274 ## 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
275 ##
5781
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents:
diff changeset
276 ## @example
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents:
diff changeset
277 ## @group
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents:
diff changeset
278 ## [ "f", 111, 111 ]
14327
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
279 ## @result{} "foo"
5781
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents:
diff changeset
280 ## @end group
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents:
diff changeset
281 ## @end example
10821
693e22af08ae Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents: 9051
diff changeset
282 ##
10846
a4f482e66b65 Grammarcheck more of the documentation.
Rik <octave@nomad.inbox5.com>
parents: 10821
diff changeset
283 ## @noindent
5781
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents:
diff changeset
284 ## 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
285 ## 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
286 ##
12477
d1466d956d17 Add a warning description for Matlab-style short-circuiting
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents: 11587
diff changeset
287 ## @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
288 ## 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
289 ## 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
290 ## 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
291 ## 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
292 ## circuit when used in a condition.
13841
0a158dbdb04a Remove 3 unused warning ids
Rik <octave@nomad.inbox5.com>
parents: 12845
diff changeset
293 ## 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
294 ## is enabled.
12477
d1466d956d17 Add a warning description for Matlab-style short-circuiting
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents: 11587
diff changeset
295 ##
5781
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents:
diff changeset
296 ## @item Octave:precedence-change
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents:
diff changeset
297 ## If the @code{Octave:precedence-change} warning is enabled, Octave
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents:
diff changeset
298 ## 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
299 ## 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
300 ## typically been made for @sc{matlab} compatibility.
0a158dbdb04a Remove 3 unused warning ids
Rik <octave@nomad.inbox5.com>
parents: 12845
diff changeset
301 ## 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
302 ##
13842
4aadd3e2c5bc warning_ids.m: Add missing warnings to list. They are not documented.
Rik <octave@nomad.inbox5.com>
parents: 13841
diff changeset
303 ## @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
304 ## 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
305 ##
15605
80a4ded6b89c warning_ids.m: Add 2 missing warning IDs to documentation.
Rik <rik@octave.org>
parents: 14366
diff changeset
306 ## @item Octave:remove-init-dir
80a4ded6b89c warning_ids.m: Add 2 missing warning IDs to documentation.
Rik <rik@octave.org>
parents: 14366
diff changeset
307 ## 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
308 ## 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
309 ## 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
310 ## @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
311 ## 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
312 ## Octave unworkable.
80a4ded6b89c warning_ids.m: Add 2 missing warning IDs to documentation.
Rik <rik@octave.org>
parents: 14366
diff changeset
313 ## 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
314 ##
5781
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents:
diff changeset
315 ## @item Octave:reload-forces-clear
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents:
diff changeset
316 ## 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
317 ## 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
318 ## 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
319 ## 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
320 ## functions that it is forced to clear.
0a158dbdb04a Remove 3 unused warning ids
Rik <octave@nomad.inbox5.com>
parents: 12845
diff changeset
321 ## 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
322 ##
5781
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents:
diff changeset
323 ## @item Octave:resize-on-range-error
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents:
diff changeset
324 ## 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
325 ## 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
326 ## indices outside the current bounds.
23090
8cb4a2c07bce doc: Fix '##' in middle of docstring/comment lines (bug #50145).50145).50145).50145).50145).
Rik <rik@octave.org>
parents: 23083
diff changeset
327 ## 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
328 ##
5794
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5781
diff changeset
329 ## @item Octave:separator-insert
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5781
diff changeset
330 ## Print warning if commas or semicolons might be inserted
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5781
diff changeset
331 ## automatically in literal matrices.
13841
0a158dbdb04a Remove 3 unused warning ids
Rik <octave@nomad.inbox5.com>
parents: 12845
diff changeset
332 ## 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
333 ##
13842
4aadd3e2c5bc warning_ids.m: Add missing warnings to list. They are not documented.
Rik <octave@nomad.inbox5.com>
parents: 13841
diff changeset
334 ## @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
335 ## 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
336 ##
5794
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5781
diff changeset
337 ## @item Octave:single-quote-string
8325
b93ac0586e4b spelling corrections
Brian Gough<bjg@network-theory.co.uk>
parents: 7017
diff changeset
338 ## 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
339 ## string constant.
13841
0a158dbdb04a Remove 3 unused warning ids
Rik <octave@nomad.inbox5.com>
parents: 12845
diff changeset
340 ## 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
341 ##
13842
4aadd3e2c5bc warning_ids.m: Add missing warnings to list. They are not documented.
Rik <octave@nomad.inbox5.com>
parents: 13841
diff changeset
342 ## @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
343 ## 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
344 ##
5781
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents:
diff changeset
345 ## @item Octave:str-to-num
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents:
diff changeset
346 ## 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
347 ## for implicit conversions of strings to their numeric ASCII equivalents.
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents:
diff changeset
348 ## For example,
10821
693e22af08ae Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents: 9051
diff changeset
349 ##
5781
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents:
diff changeset
350 ## @example
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents:
diff changeset
351 ## @group
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents:
diff changeset
352 ## "abc" + 0
14327
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
353 ## @result{} 97 98 99
5781
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents:
diff changeset
354 ## @end group
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents:
diff changeset
355 ## @end example
10821
693e22af08ae Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents: 9051
diff changeset
356 ##
10846
a4f482e66b65 Grammarcheck more of the documentation.
Rik <octave@nomad.inbox5.com>
parents: 10821
diff changeset
357 ## @noindent
5781
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents:
diff changeset
358 ## 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
359 ## 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
360 ##
5781
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents:
diff changeset
361 ## @item Octave:variable-switch-label
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe]
jwe
parents:
diff changeset
362 ## 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
363 ## 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
364 ## expression.
0a158dbdb04a Remove 3 unused warning ids
Rik <octave@nomad.inbox5.com>
parents: 12845
diff changeset
365 ## 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
366 ## @end table
17170
d6499c14021c doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 17097
diff changeset
367 ##
d6499c14021c doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 17097
diff changeset
368
8673
9e0f0a7bf858 warning_ids.m: make it a function that just calls help
John W. Eaton <jwe@octave.org>
parents: 8325
diff changeset
369 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
370 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
371 endfunction
12845
29d4b27e485d Remove warning_ids.m from test statistics.
Rik <octave@nomad.inbox5.com>
parents: 12576
diff changeset
372
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14327
diff changeset
373
19192
8a8a7bc2a09d Improve docstrings and mark documentation m-files as tested in miscellaneous/ dir.
Rik <rik@octave.org>
parents: 17744
diff changeset
374 ## 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
375 %!assert (1)