Mercurial > octave
annotate scripts/miscellaneous/warning_ids.m @ 21546:f7f97d7e9294
doc: Wrap m-file docstrings to 79 characters + newline (80 total).
* isrecording.m, soundsc.m, delaunay3.m, cell2mat.m, cumtrapz.m, del2.m,
inputParser.m, interp1.m, interp3.m, narginchk.m, profile.m,
validateattributes.m, delaunayn.m, tsearchn.m, voronoin.m, brighten.m,
cmunique.m, colorcube.m, imfinfo.m, imshow.m, edit.m, orderfields.m, run.m,
warning_ids.m, ode23.m, ode45.m, odeget.m, integrate_adaptive.m, kahan.m,
ode_struct_value_check.m, runge_kutta_23.m, fminunc.m, fsolve.m, fzero.m,
pkg.m, build.m, specular.m, view.m, bar.m, barh.m, contour3.m, isosurface.m,
line.m, pie.m, pie3.m, quiver3.m, scatter.m, scatter3.m, stem3.m, stemleaf.m,
surfl.m, tetramesh.m, isfigure.m, mkpp.m, pchip.m, residue.m, splinefit.m,
rmpref.m, unique.m, eigs.m, ilu.m, factor.m, factorial.m, gallery.m, hankel.m,
histc.m, ols.m, finv.m, fpdf.m, kruskal_wallis_test.m, weekday.m:
Wrap m-file docstrings to 79 characters + newline (80 total).
author | Rik <rik@octave.org> |
---|---|
date | Sun, 27 Mar 2016 15:50:01 -0700 |
parents | 69489c064cb7 |
children | a0ebc922fd52 |
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 | 2 ## |
3 ## This file is part of Octave. | |
4 ## | |
5 ## Octave is free software; you can redistribute it and/or modify it | |
6 ## under the terms of the GNU General Public License as published by | |
7 ## the Free Software Foundation; either version 3 of the License, or (at | |
8 ## your option) any later version. | |
9 ## | |
10 ## Octave is distributed in the hope that it will be useful, but | |
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of | |
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
13 ## General Public License for more details. | |
14 ## | |
15 ## You should have received a copy of the GNU General Public License | |
16 ## along with Octave; see the file COPYING. If not, see | |
17 ## <http://www.gnu.org/licenses/>. | |
18 | |
5781 | 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 | 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 ## |
5781 | 26 ## @item Octave:array-to-scalar |
27 ## If the @code{Octave:array-to-scalar} warning is enabled, Octave will | |
28 ## 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
|
29 ## attempted. |
0a158dbdb04a
Remove 3 unused warning ids
Rik <octave@nomad.inbox5.com>
parents:
12845
diff
changeset
|
30 ## 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
|
31 ## |
5781 | 32 ## @item Octave:array-to-vector |
33 ## If the @code{Octave:array-to-vector} warning is enabled, Octave will | |
34 ## 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
|
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-vector} 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 | 38 ## @item Octave:assign-as-truth-value |
39 ## If the @code{Octave:assign-as-truth-value} warning is | |
40 ## 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
|
41 ## |
5781 | 42 ## @example |
9051
1bf0ce0930be
Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents:
9039
diff
changeset
|
43 ## @group |
5781 | 44 ## if (s = t) |
9039
51dc9691f23f
Cleanup documentation files errors.texi, debug.texi, io.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
45 ## @dots{} |
9051
1bf0ce0930be
Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents:
9039
diff
changeset
|
46 ## @end group |
5781 | 47 ## @end example |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
48 ## |
5781 | 49 ## @noindent |
50 ## since such statements are not common, and it is likely that the intent | |
51 ## was to write | |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
52 ## |
5781 | 53 ## @example |
9051
1bf0ce0930be
Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents:
9039
diff
changeset
|
54 ## @group |
5781 | 55 ## if (s == t) |
9039
51dc9691f23f
Cleanup documentation files errors.texi, debug.texi, io.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
56 ## @dots{} |
9051
1bf0ce0930be
Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents:
9039
diff
changeset
|
57 ## @end group |
5781 | 58 ## @end example |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
59 ## |
5781 | 60 ## @noindent |
61 ## instead. | |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
62 ## |
5781 | 63 ## There are times when it is useful to write code that contains |
64 ## assignments within the condition of a @code{while} or @code{if} | |
65 ## 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
|
66 ## |
5781 | 67 ## @example |
9051
1bf0ce0930be
Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents:
9039
diff
changeset
|
68 ## @group |
14327
4d917a6a858b
doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
69 ## while (c = getc ()) |
9039
51dc9691f23f
Cleanup documentation files errors.texi, debug.texi, io.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
70 ## @dots{} |
9051
1bf0ce0930be
Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents:
9039
diff
changeset
|
71 ## @end group |
5781 | 72 ## @end example |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
73 ## |
5781 | 74 ## @noindent |
75 ## 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
|
76 ## |
5781 | 77 ## It is possible to avoid all warnings about such statements by |
78 ## disabling the @code{Octave:assign-as-truth-value} warning, | |
79 ## 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
|
80 ## |
5781 | 81 ## @example |
9051
1bf0ce0930be
Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents:
9039
diff
changeset
|
82 ## @group |
5781 | 83 ## 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
|
84 ## @dots{} |
9051
1bf0ce0930be
Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents:
9039
diff
changeset
|
85 ## @end group |
5781 | 86 ## @end example |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
87 ## |
5781 | 88 ## @noindent |
89 ## slip by. | |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
90 ## |
5781 | 91 ## In such cases, it is possible suppress errors for specific statements by |
92 ## writing them with an extra set of parentheses. For example, writing the | |
93 ## previous example as | |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
94 ## |
5781 | 95 ## @example |
9051
1bf0ce0930be
Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents:
9039
diff
changeset
|
96 ## @group |
14327
4d917a6a858b
doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
97 ## while ((c = getc ())) |
9039
51dc9691f23f
Cleanup documentation files errors.texi, debug.texi, io.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
98 ## @dots{} |
9051
1bf0ce0930be
Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents:
9039
diff
changeset
|
99 ## @end group |
5781 | 100 ## @end example |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
101 ## |
5781 | 102 ## @noindent |
103 ## will prevent the warning from being printed for this statement, while | |
104 ## allowing Octave to warn about other assignments used in conditional | |
105 ## contexts. | |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
106 ## |
5781 | 107 ## 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
|
108 ## |
5781 | 109 ## @item Octave:associativity-change |
110 ## If the @code{Octave:associativity-change} warning is | |
111 ## enabled, Octave will warn about possible changes in the meaning of | |
112 ## 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
|
113 ## 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
|
114 ## compatibility. |
0a158dbdb04a
Remove 3 unused warning ids
Rik <octave@nomad.inbox5.com>
parents:
12845
diff
changeset
|
115 ## 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
|
116 ## |
12486
32279948bf3b
Document the Octave:autoload-relative-file-name warning.
Thomas Weber <tweber@debian.org>
parents:
12477
diff
changeset
|
117 ## @item Octave:autoload-relative-file-name |
32279948bf3b
Document the Octave:autoload-relative-file-name warning.
Thomas Weber <tweber@debian.org>
parents:
12477
diff
changeset
|
118 ## 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
|
119 ## 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
|
120 ## 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
|
121 ## 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
|
122 ## 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
|
123 ## 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
|
124 ## enabled. |
12486
32279948bf3b
Document the Octave:autoload-relative-file-name warning.
Thomas Weber <tweber@debian.org>
parents:
12477
diff
changeset
|
125 ## |
13842
4aadd3e2c5bc
warning_ids.m: Add missing warnings to list. They are not documented.
Rik <octave@nomad.inbox5.com>
parents:
13841
diff
changeset
|
126 ## @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
|
127 ## 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
|
128 ## enabled. |
4aadd3e2c5bc
warning_ids.m: Add missing warnings to list. They are not documented.
Rik <octave@nomad.inbox5.com>
parents:
13841
diff
changeset
|
129 ## |
15605
80a4ded6b89c
warning_ids.m: Add 2 missing warning IDs to documentation.
Rik <rik@octave.org>
parents:
14366
diff
changeset
|
130 ## @item Octave:deprecated-keyword |
80a4ded6b89c
warning_ids.m: Add 2 missing warning IDs to documentation.
Rik <rik@octave.org>
parents:
14366
diff
changeset
|
131 ## 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
|
132 ## 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
|
133 ## scheduled for removal from Octave. |
80a4ded6b89c
warning_ids.m: Add 2 missing warning IDs to documentation.
Rik <rik@octave.org>
parents:
14366
diff
changeset
|
134 ## 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
|
135 ## |
5781 | 136 ## @item Octave:divide-by-zero |
137 ## 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
|
138 ## 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
|
139 ## 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
|
140 ## |
13842
4aadd3e2c5bc
warning_ids.m: Add missing warnings to list. They are not documented.
Rik <octave@nomad.inbox5.com>
parents:
13841
diff
changeset
|
141 ## @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
|
142 ## 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
|
143 ## |
5781 | 144 ## @item Octave:function-name-clash |
145 ## If the @code{Octave:function-name-clash} warning is enabled, a | |
146 ## warning is issued when Octave finds that the name of a function | |
147 ## defined in a function file differs from the name of the file. (If | |
148 ## the names disagree, the name declared inside the file is ignored.) | |
149 ## 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
|
150 ## |
5781 | 151 ## @item Octave:future-time-stamp |
152 ## If the @code{Octave:future-time-stamp} warning is enabled, Octave | |
153 ## 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
|
154 ## that is in the future. |
0a158dbdb04a
Remove 3 unused warning ids
Rik <octave@nomad.inbox5.com>
parents:
12845
diff
changeset
|
155 ## 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
|
156 ## |
13842
4aadd3e2c5bc
warning_ids.m: Add missing warnings to list. They are not documented.
Rik <octave@nomad.inbox5.com>
parents:
13841
diff
changeset
|
157 ## @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
|
158 ## 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
|
159 ## |
5781 | 160 ## @item Octave:imag-to-real |
161 ## If the @code{Octave:imag-to-real} warning is enabled, a warning is | |
162 ## printed for implicit conversions of complex numbers to real numbers. | |
163 ## 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
|
164 ## |
19852
e9a0bd0b125c
Rename 'matlab-incompatible' warning to 'language-extension'.
Carnë Draug <carandraug@octave.org>
parents:
19851
diff
changeset
|
165 ## @item Octave:language-extension |
e9a0bd0b125c
Rename 'matlab-incompatible' warning to 'language-extension'.
Carnë Draug <carandraug@octave.org>
parents:
19851
diff
changeset
|
166 ## 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
|
167 ## 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
|
168 ## 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
|
169 ## The @option{--traditional} or @option{--braindead} startup options for |
e51473fdb622
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
19852
diff
changeset
|
170 ## 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
|
171 ## |
13842
4aadd3e2c5bc
warning_ids.m: Add missing warnings to list. They are not documented.
Rik <octave@nomad.inbox5.com>
parents:
13841
diff
changeset
|
172 ## @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
|
173 ## 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
|
174 ## |
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:logical-conversion |
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: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
|
177 ## |
4aadd3e2c5bc
warning_ids.m: Add missing warnings to list. They are not documented.
Rik <octave@nomad.inbox5.com>
parents:
13841
diff
changeset
|
178 ## @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
|
179 ## 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
|
180 ## |
5781 | 181 ## @item Octave:missing-semicolon |
182 ## If the @code{Octave:missing-semicolon} warning is enabled, Octave | |
183 ## 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
|
184 ## semicolons. |
0a158dbdb04a
Remove 3 unused warning ids
Rik <octave@nomad.inbox5.com>
parents:
12845
diff
changeset
|
185 ## 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
|
186 ## |
0a158dbdb04a
Remove 3 unused warning ids
Rik <octave@nomad.inbox5.com>
parents:
12845
diff
changeset
|
187 ## @item Octave:mixed-string-concat |
0a158dbdb04a
Remove 3 unused warning ids
Rik <octave@nomad.inbox5.com>
parents:
12845
diff
changeset
|
188 ## 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
|
189 ## 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
|
190 ## 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
|
191 ## |
5781 | 192 ## @item Octave:neg-dim-as-zero |
193 ## If the @code{Octave:neg-dim-as-zero} warning is enabled, print a warning | |
194 ## for expressions like | |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
195 ## |
5781 | 196 ## @example |
197 ## eye (-1) | |
198 ## @end example | |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
199 ## |
5781 | 200 ## @noindent |
201 ## 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
|
202 ## |
13842
4aadd3e2c5bc
warning_ids.m: Add missing warnings to list. They are not documented.
Rik <octave@nomad.inbox5.com>
parents:
13841
diff
changeset
|
203 ## @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
|
204 ## 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
|
205 ## |
4aadd3e2c5bc
warning_ids.m: Add missing warnings to list. They are not documented.
Rik <octave@nomad.inbox5.com>
parents:
13841
diff
changeset
|
206 ## @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
|
207 ## 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
|
208 ## |
5781 | 209 ## @item Octave:num-to-str |
210 ## If the @code{Octave:num-to-str} warning is enable, a warning is | |
211 ## printed for implicit conversions of numbers to their ASCII character | |
212 ## equivalents when strings are constructed using a mixture of strings and | |
213 ## 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
|
214 ## |
5781 | 215 ## @example |
216 ## @group | |
217 ## [ "f", 111, 111 ] | |
14327
4d917a6a858b
doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
218 ## @result{} "foo" |
5781 | 219 ## @end group |
220 ## @end example | |
10821
693e22af08ae
Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents:
9051
diff
changeset
|
221 ## |
10846
a4f482e66b65
Grammarcheck more of the documentation.
Rik <octave@nomad.inbox5.com>
parents:
10821
diff
changeset
|
222 ## @noindent |
5781 | 223 ## elicits a warning if the @code{Octave:num-to-str} warning is |
224 ## 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
|
225 ## |
12477
d1466d956d17
Add a warning description for Matlab-style short-circuiting
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
11587
diff
changeset
|
226 ## @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
|
227 ## 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
|
228 ## 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
|
229 ## 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
|
230 ## 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
|
231 ## 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
|
232 ## 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
|
233 ## |
d1466d956d17
Add a warning description for Matlab-style short-circuiting
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
11587
diff
changeset
|
234 ## @example |
d1466d956d17
Add a warning description for Matlab-style short-circuiting
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
11587
diff
changeset
|
235 ## @group |
14327
4d917a6a858b
doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
236 ## 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
|
237 ## @end group |
d1466d956d17
Add a warning description for Matlab-style short-circuiting
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
11587
diff
changeset
|
238 ## @end example |
d1466d956d17
Add a warning description for Matlab-style short-circuiting
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
11587
diff
changeset
|
239 ## |
d1466d956d17
Add a warning description for Matlab-style short-circuiting
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
11587
diff
changeset
|
240 ## @noindent |
d1466d956d17
Add a warning description for Matlab-style short-circuiting
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
11587
diff
changeset
|
241 ## 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
|
242 ## 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
|
243 ## 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
|
244 ## 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
|
245 ## existing code that relies on this behavior. |
13841
0a158dbdb04a
Remove 3 unused warning ids
Rik <octave@nomad.inbox5.com>
parents:
12845
diff
changeset
|
246 ## 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
|
247 ## is enabled. |
12477
d1466d956d17
Add a warning description for Matlab-style short-circuiting
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
11587
diff
changeset
|
248 ## |
5781 | 249 ## @item Octave:precedence-change |
250 ## If the @code{Octave:precedence-change} warning is enabled, Octave | |
251 ## will warn about possible changes in the meaning of some code due to | |
252 ## 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
|
253 ## typically been made for @sc{matlab} compatibility. |
0a158dbdb04a
Remove 3 unused warning ids
Rik <octave@nomad.inbox5.com>
parents:
12845
diff
changeset
|
254 ## 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
|
255 ## |
13842
4aadd3e2c5bc
warning_ids.m: Add missing warnings to list. They are not documented.
Rik <octave@nomad.inbox5.com>
parents:
13841
diff
changeset
|
256 ## @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
|
257 ## 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
|
258 ## |
15605
80a4ded6b89c
warning_ids.m: Add 2 missing warning IDs to documentation.
Rik <rik@octave.org>
parents:
14366
diff
changeset
|
259 ## @item Octave:remove-init-dir |
80a4ded6b89c
warning_ids.m: Add 2 missing warning IDs to documentation.
Rik <rik@octave.org>
parents:
14366
diff
changeset
|
260 ## 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
|
261 ## 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
|
262 ## 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
|
263 ## @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
|
264 ## 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
|
265 ## Octave unworkable. |
80a4ded6b89c
warning_ids.m: Add 2 missing warning IDs to documentation.
Rik <rik@octave.org>
parents:
14366
diff
changeset
|
266 ## 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
|
267 ## |
5781 | 268 ## @item Octave:reload-forces-clear |
269 ## If several functions have been loaded from the same file, Octave must | |
270 ## clear all the functions before any one of them can be reloaded. If | |
271 ## the @code{Octave:reload-forces-clear} warning is enabled, Octave will | |
272 ## 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
|
273 ## functions that it is forced to clear. |
0a158dbdb04a
Remove 3 unused warning ids
Rik <octave@nomad.inbox5.com>
parents:
12845
diff
changeset
|
274 ## 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
|
275 ## |
5781 | 276 ## @item Octave:resize-on-range-error |
277 ## If the @code{Octave:resize-on-range-error} warning is enabled, print a | |
278 ## 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
|
279 ## indices outside the current bounds. |
0a158dbdb04a
Remove 3 unused warning ids
Rik <octave@nomad.inbox5.com>
parents:
12845
diff
changeset
|
280 ## 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
|
281 ## |
5794 | 282 ## @item Octave:separator-insert |
283 ## Print warning if commas or semicolons might be inserted | |
284 ## automatically in literal matrices. | |
13841
0a158dbdb04a
Remove 3 unused warning ids
Rik <octave@nomad.inbox5.com>
parents:
12845
diff
changeset
|
285 ## 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
|
286 ## |
13842
4aadd3e2c5bc
warning_ids.m: Add missing warnings to list. They are not documented.
Rik <octave@nomad.inbox5.com>
parents:
13841
diff
changeset
|
287 ## @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
|
288 ## 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
|
289 ## |
5794 | 290 ## @item Octave:single-quote-string |
8325
b93ac0586e4b
spelling corrections
Brian Gough<bjg@network-theory.co.uk>
parents:
7017
diff
changeset
|
291 ## Print warning if a single quote character is used to introduce a |
5794 | 292 ## string constant. |
13841
0a158dbdb04a
Remove 3 unused warning ids
Rik <octave@nomad.inbox5.com>
parents:
12845
diff
changeset
|
293 ## 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
|
294 ## |
19576
e97c63531e76
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
19408
diff
changeset
|
295 ## @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
|
296 ## @itemx Octave:singular-matrix |
a0c7001cf1a8
consistent messages and IDs for singular matrix warnings
John W. Eaton <jwe@octave.org>
parents:
19192
diff
changeset
|
297 ## 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
|
298 ## @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
|
299 ## |
4aadd3e2c5bc
warning_ids.m: Add missing warnings to list. They are not documented.
Rik <octave@nomad.inbox5.com>
parents:
13841
diff
changeset
|
300 ## @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
|
301 ## 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
|
302 ## |
5781 | 303 ## @item Octave:str-to-num |
304 ## If the @code{Octave:str-to-num} warning is enabled, a warning is printed | |
305 ## for implicit conversions of strings to their numeric ASCII equivalents. | |
306 ## For example, | |
10821
693e22af08ae
Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents:
9051
diff
changeset
|
307 ## |
5781 | 308 ## @example |
309 ## @group | |
310 ## "abc" + 0 | |
14327
4d917a6a858b
doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
311 ## @result{} 97 98 99 |
5781 | 312 ## @end group |
313 ## @end example | |
10821
693e22af08ae
Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents:
9051
diff
changeset
|
314 ## |
10846
a4f482e66b65
Grammarcheck more of the documentation.
Rik <octave@nomad.inbox5.com>
parents:
10821
diff
changeset
|
315 ## @noindent |
5781 | 316 ## elicits a warning if the @code{Octave:str-to-num} warning is enabled. |
317 ## 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
|
318 ## |
5781 | 319 ## @item Octave:undefined-return-values |
320 ## If the @code{Octave:undefined-return-values} warning is disabled, | |
321 ## 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
|
322 ## the return list which are expected. |
0a158dbdb04a
Remove 3 unused warning ids
Rik <octave@nomad.inbox5.com>
parents:
12845
diff
changeset
|
323 ## 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
|
324 ## |
5781 | 325 ## @item Octave:variable-switch-label |
326 ## If the @code{Octave:variable-switch-label} warning is enabled, Octave | |
327 ## 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
|
328 ## expression. |
0a158dbdb04a
Remove 3 unused warning ids
Rik <octave@nomad.inbox5.com>
parents:
12845
diff
changeset
|
329 ## By default, the @code{Octave:variable-switch-label} warning is disabled. |
5781 | 330 ## @end table |
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17097
diff
changeset
|
331 ## |
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17097
diff
changeset
|
332 |
8673
9e0f0a7bf858
warning_ids.m: make it a function that just calls help
John W. Eaton <jwe@octave.org>
parents:
8325
diff
changeset
|
333 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
|
334 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
|
335 endfunction |
12845
29d4b27e485d
Remove warning_ids.m from test statistics.
Rik <octave@nomad.inbox5.com>
parents:
12576
diff
changeset
|
336 |
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14327
diff
changeset
|
337 |
19192
8a8a7bc2a09d
Improve docstrings and mark documentation m-files as tested in miscellaneous/ dir.
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
338 ## 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
|
339 %!assert (1) |
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14327
diff
changeset
|
340 |