Mercurial > octave
annotate scripts/help/warning_ids.m @ 27919:1891570abac8
update Octave Project Developers copyright for the new year
In files that have the "Octave Project Developers" copyright notice,
update for 2020.
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Mon, 06 Jan 2020 22:29:51 -0500 |
parents | b442ec6dda5c |
children | bd51beb6205e |
rev | line source |
---|---|
27919
1891570abac8
update Octave Project Developers copyright for the new year
John W. Eaton <jwe@octave.org>
parents:
27918
diff
changeset
|
1 ## Copyright (C) 2006-2020 The Octave Project Developers |
27918
b442ec6dda5c
use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents:
27517
diff
changeset
|
2 ## |
b442ec6dda5c
use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents:
27517
diff
changeset
|
3 ## See the file COPYRIGHT.md in the top-level directory of this distribution |
b442ec6dda5c
use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents:
27517
diff
changeset
|
4 ## or <https://octave.org/COPYRIGHT.html/>. |
b442ec6dda5c
use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents:
27517
diff
changeset
|
5 ## |
7016 | 6 ## |
7 ## This file is part of Octave. | |
8 ## | |
24534
194eb4bd202b
maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents:
24473
diff
changeset
|
9 ## Octave is free software: you can redistribute it and/or modify it |
7016 | 10 ## 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
|
11 ## 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
|
12 ## (at your option) any later version. |
7016 | 13 ## |
14 ## Octave is distributed in the hope that it will be useful, but | |
15 ## WITHOUT ANY WARRANTY; without even the implied warranty of | |
22755
3a2b891d0b33
maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents:
22323
diff
changeset
|
16 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
3a2b891d0b33
maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents:
22323
diff
changeset
|
17 ## GNU General Public License for more details. |
7016 | 18 ## |
19 ## You should have received a copy of the GNU General Public License | |
20 ## 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
|
21 ## <https://www.gnu.org/licenses/>. |
7016 | 22 |
5781 | 23 ## -*- texinfo -*- |
14119
94e2a76f1e5a
doc: Final grammarcheck and spellcheck before 3.6.0 release.
Rik <octave@nomad.inbox5.com>
parents:
14116
diff
changeset
|
24 ## @cindex warning ids |
14366
b76f0740940e
doc: Periodic grammar check of documentation.
Rik <octave@nomad.inbox5.com>
parents:
14363
diff
changeset
|
25 ## |
5781 | 26 ## @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
|
27 ## @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
|
28 ## 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
|
29 ## |
23994
8785b3717140
Issue a warning if addpath() called for a +pkg directory (bug #45410).
Rik <rik@octave.org>
parents:
23918
diff
changeset
|
30 ## @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
|
31 ## 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
|
32 ## 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
|
33 ## 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
|
34 ## 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
|
35 ## 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
|
36 ## |
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
|
37 ## @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
|
38 ## 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
|
39 ## Octave will warn when an array of size greater than 1x1 is used |
27062
ffdfeb835aef
warning_ids.m: Add docstring for new "Octave:empty-index" ID (bug #56167).
Rik <rik@octave.org>
parents:
26935
diff
changeset
|
40 ## as a truth value in an if, while, or until statement. |
21990
efce657ceb86
Provide a warning when an array is used in an if/while/until (bug #43098).
Lachlan Andrew <lachlanbis@gmail.com>
parents:
21695
diff
changeset
|
41 ## 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
|
42 ## |
5781 | 43 ## @item Octave:array-to-scalar |
44 ## If the @code{Octave:array-to-scalar} warning is enabled, Octave will | |
45 ## 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
|
46 ## attempted. |
0a158dbdb04a
Remove 3 unused warning ids
Rik <octave@nomad.inbox5.com>
parents:
12845
diff
changeset
|
47 ## 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
|
48 ## |
5781 | 49 ## @item Octave:array-to-vector |
50 ## If the @code{Octave:array-to-vector} warning is enabled, Octave will | |
51 ## 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
|
52 ## attempted. |
0a158dbdb04a
Remove 3 unused warning ids
Rik <octave@nomad.inbox5.com>
parents:
12845
diff
changeset
|
53 ## 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
|
54 ## |
5781 | 55 ## @item Octave:assign-as-truth-value |
56 ## If the @code{Octave:assign-as-truth-value} warning is | |
57 ## 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
|
58 ## |
5781 | 59 ## @example |
9051
1bf0ce0930be
Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents:
9039
diff
changeset
|
60 ## @group |
5781 | 61 ## if (s = t) |
9039
51dc9691f23f
Cleanup documentation files errors.texi, debug.texi, io.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
62 ## @dots{} |
9051
1bf0ce0930be
Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents:
9039
diff
changeset
|
63 ## @end group |
5781 | 64 ## @end example |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
65 ## |
5781 | 66 ## @noindent |
67 ## since such statements are not common, and it is likely that the intent | |
68 ## was to write | |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
69 ## |
5781 | 70 ## @example |
9051
1bf0ce0930be
Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents:
9039
diff
changeset
|
71 ## @group |
5781 | 72 ## if (s == t) |
9039
51dc9691f23f
Cleanup documentation files errors.texi, debug.texi, io.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
73 ## @dots{} |
9051
1bf0ce0930be
Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents:
9039
diff
changeset
|
74 ## @end group |
5781 | 75 ## @end example |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
76 ## |
5781 | 77 ## @noindent |
78 ## instead. | |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
79 ## |
5781 | 80 ## There are times when it is useful to write code that contains |
81 ## assignments within the condition of a @code{while} or @code{if} | |
82 ## 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
|
83 ## |
5781 | 84 ## @example |
9051
1bf0ce0930be
Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents:
9039
diff
changeset
|
85 ## @group |
14327
4d917a6a858b
doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
86 ## while (c = getc ()) |
9039
51dc9691f23f
Cleanup documentation files errors.texi, debug.texi, io.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
87 ## @dots{} |
9051
1bf0ce0930be
Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents:
9039
diff
changeset
|
88 ## @end group |
5781 | 89 ## @end example |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
90 ## |
5781 | 91 ## @noindent |
92 ## 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
|
93 ## |
5781 | 94 ## It is possible to avoid all warnings about such statements by |
95 ## disabling the @code{Octave:assign-as-truth-value} warning, | |
96 ## 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
|
97 ## |
5781 | 98 ## @example |
9051
1bf0ce0930be
Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents:
9039
diff
changeset
|
99 ## @group |
5781 | 100 ## 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
|
101 ## @dots{} |
9051
1bf0ce0930be
Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents:
9039
diff
changeset
|
102 ## @end group |
5781 | 103 ## @end example |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
104 ## |
5781 | 105 ## @noindent |
106 ## slip by. | |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
107 ## |
5781 | 108 ## In such cases, it is possible suppress errors for specific statements by |
109 ## writing them with an extra set of parentheses. For example, writing the | |
110 ## previous example as | |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
111 ## |
5781 | 112 ## @example |
9051
1bf0ce0930be
Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents:
9039
diff
changeset
|
113 ## @group |
14327
4d917a6a858b
doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
114 ## while ((c = getc ())) |
9039
51dc9691f23f
Cleanup documentation files errors.texi, debug.texi, io.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
115 ## @dots{} |
9051
1bf0ce0930be
Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents:
9039
diff
changeset
|
116 ## @end group |
5781 | 117 ## @end example |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
118 ## |
5781 | 119 ## @noindent |
120 ## will prevent the warning from being printed for this statement, while | |
121 ## allowing Octave to warn about other assignments used in conditional | |
122 ## contexts. | |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
123 ## |
5781 | 124 ## 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
|
125 ## |
5781 | 126 ## @item Octave:associativity-change |
127 ## If the @code{Octave:associativity-change} warning is | |
128 ## enabled, Octave will warn about possible changes in the meaning of | |
129 ## 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
|
130 ## 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
|
131 ## compatibility. |
0a158dbdb04a
Remove 3 unused warning ids
Rik <octave@nomad.inbox5.com>
parents:
12845
diff
changeset
|
132 ## 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
|
133 ## |
12486
32279948bf3b
Document the Octave:autoload-relative-file-name warning.
Thomas Weber <tweber@debian.org>
parents:
12477
diff
changeset
|
134 ## @item Octave:autoload-relative-file-name |
32279948bf3b
Document the Octave:autoload-relative-file-name warning.
Thomas Weber <tweber@debian.org>
parents:
12477
diff
changeset
|
135 ## 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
|
136 ## 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
|
137 ## 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
|
138 ## 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
|
139 ## 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
|
140 ## 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
|
141 ## enabled. |
12486
32279948bf3b
Document the Octave:autoload-relative-file-name warning.
Thomas Weber <tweber@debian.org>
parents:
12477
diff
changeset
|
142 ## |
13842
4aadd3e2c5bc
warning_ids.m: Add missing warnings to list. They are not documented.
Rik <octave@nomad.inbox5.com>
parents:
13841
diff
changeset
|
143 ## @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
|
144 ## 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
|
145 ## enabled. |
4aadd3e2c5bc
warning_ids.m: Add missing warnings to list. They are not documented.
Rik <octave@nomad.inbox5.com>
parents:
13841
diff
changeset
|
146 ## |
27517
85ad4689aa05
Add warning when non-scalar argument presented to ':' range operator.
Rik <rik@octave.org>
parents:
27066
diff
changeset
|
147 ## @item Octave:colon-complex-argument |
85ad4689aa05
Add warning when non-scalar argument presented to ':' range operator.
Rik <rik@octave.org>
parents:
27066
diff
changeset
|
148 ## If the @code{Octave:colon-complex-argument} warning is enabled, a warning |
85ad4689aa05
Add warning when non-scalar argument presented to ':' range operator.
Rik <rik@octave.org>
parents:
27066
diff
changeset
|
149 ## is issued when one of the three arguments to the colon operator (base, |
85ad4689aa05
Add warning when non-scalar argument presented to ':' range operator.
Rik <rik@octave.org>
parents:
27066
diff
changeset
|
150 ## increment, limit) is a complex value. For example, @code{1:3*i} will |
85ad4689aa05
Add warning when non-scalar argument presented to ':' range operator.
Rik <rik@octave.org>
parents:
27066
diff
changeset
|
151 ## cause a warning to be emitted. |
85ad4689aa05
Add warning when non-scalar argument presented to ':' range operator.
Rik <rik@octave.org>
parents:
27066
diff
changeset
|
152 ## By default, the @code{Octave:colon-complex-argument} warning is enabled. |
85ad4689aa05
Add warning when non-scalar argument presented to ':' range operator.
Rik <rik@octave.org>
parents:
27066
diff
changeset
|
153 ## |
85ad4689aa05
Add warning when non-scalar argument presented to ':' range operator.
Rik <rik@octave.org>
parents:
27066
diff
changeset
|
154 ## @item Octave:colon-nonscalar-argument |
85ad4689aa05
Add warning when non-scalar argument presented to ':' range operator.
Rik <rik@octave.org>
parents:
27066
diff
changeset
|
155 ## If the @code{Octave:colon-nonscalar-argument} warning is enabled, a warning |
85ad4689aa05
Add warning when non-scalar argument presented to ':' range operator.
Rik <rik@octave.org>
parents:
27066
diff
changeset
|
156 ## is issued when one of the three arguments to the colon operator (base, |
85ad4689aa05
Add warning when non-scalar argument presented to ':' range operator.
Rik <rik@octave.org>
parents:
27066
diff
changeset
|
157 ## increment, limit) is not a scalar. For example, @code{1:[3, 5]} will |
85ad4689aa05
Add warning when non-scalar argument presented to ':' range operator.
Rik <rik@octave.org>
parents:
27066
diff
changeset
|
158 ## cause a warning to be emitted. |
85ad4689aa05
Add warning when non-scalar argument presented to ':' range operator.
Rik <rik@octave.org>
parents:
27066
diff
changeset
|
159 ## By default, the @code{Octave:colon-nonscalar-argument} warning is enabled. |
85ad4689aa05
Add warning when non-scalar argument presented to ':' range operator.
Rik <rik@octave.org>
parents:
27066
diff
changeset
|
160 ## |
27062
ffdfeb835aef
warning_ids.m: Add docstring for new "Octave:empty-index" ID (bug #56167).
Rik <rik@octave.org>
parents:
26935
diff
changeset
|
161 ## @item Octave:data-file-in-path |
ffdfeb835aef
warning_ids.m: Add docstring for new "Octave:empty-index" ID (bug #56167).
Rik <rik@octave.org>
parents:
26935
diff
changeset
|
162 ## If the @code{Octave:data-file-in-path} warning is enabled, a warning is |
ffdfeb835aef
warning_ids.m: Add docstring for new "Octave:empty-index" ID (bug #56167).
Rik <rik@octave.org>
parents:
26935
diff
changeset
|
163 ## issued when Octave does not find the target of a file operation such as |
ffdfeb835aef
warning_ids.m: Add docstring for new "Octave:empty-index" ID (bug #56167).
Rik <rik@octave.org>
parents:
26935
diff
changeset
|
164 ## @code{load} or @code{fopen} directly, but is able to locate the file in |
ffdfeb835aef
warning_ids.m: Add docstring for new "Octave:empty-index" ID (bug #56167).
Rik <rik@octave.org>
parents:
26935
diff
changeset
|
165 ## Octave's search @code{path} for files. The warning could indicate that a |
ffdfeb835aef
warning_ids.m: Add docstring for new "Octave:empty-index" ID (bug #56167).
Rik <rik@octave.org>
parents:
26935
diff
changeset
|
166 ## different file target than the programmer intended is being used. |
ffdfeb835aef
warning_ids.m: Add docstring for new "Octave:empty-index" ID (bug #56167).
Rik <rik@octave.org>
parents:
26935
diff
changeset
|
167 ## By default, the @code{Octave:data-file-in-path} warning is enabled. |
ffdfeb835aef
warning_ids.m: Add docstring for new "Octave:empty-index" ID (bug #56167).
Rik <rik@octave.org>
parents:
26935
diff
changeset
|
168 ## |
21654
a0ebc922fd52
Add "facenormals" and "*normalsmode" to "surface" and "patch" (bug #47791)
mmuetzel <markus.muetzel@gmx.de>
parents:
21546
diff
changeset
|
169 ## @item Octave:deprecated-function |
a0ebc922fd52
Add "facenormals" and "*normalsmode" to "surface" and "patch" (bug #47791)
mmuetzel <markus.muetzel@gmx.de>
parents:
21546
diff
changeset
|
170 ## 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
|
171 ## 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
|
172 ## 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
|
173 ## 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
|
174 ## |
15605
80a4ded6b89c
warning_ids.m: Add 2 missing warning IDs to documentation.
Rik <rik@octave.org>
parents:
14366
diff
changeset
|
175 ## @item Octave:deprecated-keyword |
80a4ded6b89c
warning_ids.m: Add 2 missing warning IDs to documentation.
Rik <rik@octave.org>
parents:
14366
diff
changeset
|
176 ## 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
|
177 ## 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
|
178 ## scheduled for removal from Octave. |
80a4ded6b89c
warning_ids.m: Add 2 missing warning IDs to documentation.
Rik <rik@octave.org>
parents:
14366
diff
changeset
|
179 ## 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
|
180 ## |
21654
a0ebc922fd52
Add "facenormals" and "*normalsmode" to "surface" and "patch" (bug #47791)
mmuetzel <markus.muetzel@gmx.de>
parents:
21546
diff
changeset
|
181 ## @item Octave:deprecated-property |
a0ebc922fd52
Add "facenormals" and "*normalsmode" to "surface" and "patch" (bug #47791)
mmuetzel <markus.muetzel@gmx.de>
parents:
21546
diff
changeset
|
182 ## 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
|
183 ## 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
|
184 ## 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
|
185 ## 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
|
186 ## |
24334
d3d38a443df8
Add new warning ID "Octave:eigs:UnconvergedEigenvalues".
Rik <rik@octave.org>
parents:
24034
diff
changeset
|
187 ## @item Octave:eigs:UnconvergedEigenvalues |
d3d38a443df8
Add new warning ID "Octave:eigs:UnconvergedEigenvalues".
Rik <rik@octave.org>
parents:
24034
diff
changeset
|
188 ## 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
|
189 ## 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
|
190 ## 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
|
191 ## 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
|
192 ## enabled. |
d3d38a443df8
Add new warning ID "Octave:eigs:UnconvergedEigenvalues".
Rik <rik@octave.org>
parents:
24034
diff
changeset
|
193 ## |
27062
ffdfeb835aef
warning_ids.m: Add docstring for new "Octave:empty-index" ID (bug #56167).
Rik <rik@octave.org>
parents:
26935
diff
changeset
|
194 ## @item Octave:empty-index |
27066 | 195 ## If the @code{Octave:empty-index} warning is enabled then Octave will emit a |
27062
ffdfeb835aef
warning_ids.m: Add docstring for new "Octave:empty-index" ID (bug #56167).
Rik <rik@octave.org>
parents:
26935
diff
changeset
|
196 ## warning whenever indexing operators are used without an index, for example |
ffdfeb835aef
warning_ids.m: Add docstring for new "Octave:empty-index" ID (bug #56167).
Rik <rik@octave.org>
parents:
26935
diff
changeset
|
197 ## @code{@var{x}()}. |
ffdfeb835aef
warning_ids.m: Add docstring for new "Octave:empty-index" ID (bug #56167).
Rik <rik@octave.org>
parents:
26935
diff
changeset
|
198 ## By default, the @code{Octave:empty-index} warning is enabled. |
ffdfeb835aef
warning_ids.m: Add docstring for new "Octave:empty-index" ID (bug #56167).
Rik <rik@octave.org>
parents:
26935
diff
changeset
|
199 ## |
24473
42d099b841aa
erase.m: Add warning if a character array is used for PTN.
Rik <rik@octave.org>
parents:
24334
diff
changeset
|
200 ## @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
|
201 ## 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
|
202 ## 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
|
203 ## 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
|
204 ## 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
|
205 ## |
5781 | 206 ## @item Octave:function-name-clash |
207 ## If the @code{Octave:function-name-clash} warning is enabled, a | |
208 ## warning is issued when Octave finds that the name of a function | |
209 ## defined in a function file differs from the name of the file. (If | |
210 ## the names disagree, the name declared inside the file is ignored.) | |
211 ## 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
|
212 ## |
5781 | 213 ## @item Octave:future-time-stamp |
214 ## If the @code{Octave:future-time-stamp} warning is enabled, Octave | |
215 ## 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
|
216 ## that is in the future. |
0a158dbdb04a
Remove 3 unused warning ids
Rik <octave@nomad.inbox5.com>
parents:
12845
diff
changeset
|
217 ## 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
|
218 ## |
13842
4aadd3e2c5bc
warning_ids.m: Add missing warnings to list. They are not documented.
Rik <octave@nomad.inbox5.com>
parents:
13841
diff
changeset
|
219 ## @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
|
220 ## 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
|
221 ## |
5781 | 222 ## @item Octave:imag-to-real |
223 ## If the @code{Octave:imag-to-real} warning is enabled, a warning is | |
224 ## printed for implicit conversions of complex numbers to real numbers. | |
225 ## 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
|
226 ## |
19852
e9a0bd0b125c
Rename 'matlab-incompatible' warning to 'language-extension'.
Carnë Draug <carandraug@octave.org>
parents:
19851
diff
changeset
|
227 ## @item Octave:language-extension |
e9a0bd0b125c
Rename 'matlab-incompatible' warning to 'language-extension'.
Carnë Draug <carandraug@octave.org>
parents:
19851
diff
changeset
|
228 ## 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
|
229 ## 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
|
230 ## 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
|
231 ## The @option{--traditional} or @option{--braindead} startup options for |
e51473fdb622
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
19852
diff
changeset
|
232 ## 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
|
233 ## |
25720
e9f107d31799
warning_ids.m: Document new Octave:legacy-function warning.
Rik <rik@octave.org>
parents:
25579
diff
changeset
|
234 ## @item Octave:legacy-function |
e9f107d31799
warning_ids.m: Document new Octave:legacy-function warning.
Rik <rik@octave.org>
parents:
25579
diff
changeset
|
235 ## 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
|
236 ## 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
|
237 ## 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
|
238 ## 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
|
239 ## @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
|
240 ## 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
|
241 ## 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
|
242 ## |
13842
4aadd3e2c5bc
warning_ids.m: Add missing warnings to list. They are not documented.
Rik <octave@nomad.inbox5.com>
parents:
13841
diff
changeset
|
243 ## @item Octave:logical-conversion |
4aadd3e2c5bc
warning_ids.m: Add missing warnings to list. They are not documented.
Rik <octave@nomad.inbox5.com>
parents:
13841
diff
changeset
|
244 ## 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
|
245 ## |
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
|
246 ## @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
|
247 ## 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
|
248 ## 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
|
249 ## 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
|
250 ## 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
|
251 ## 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
|
252 ## |
13842
4aadd3e2c5bc
warning_ids.m: Add missing warnings to list. They are not documented.
Rik <octave@nomad.inbox5.com>
parents:
13841
diff
changeset
|
253 ## @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
|
254 ## 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
|
255 ## |
5781 | 256 ## @item Octave:missing-semicolon |
257 ## If the @code{Octave:missing-semicolon} warning is enabled, Octave | |
258 ## 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
|
259 ## semicolons. |
0a158dbdb04a
Remove 3 unused warning ids
Rik <octave@nomad.inbox5.com>
parents:
12845
diff
changeset
|
260 ## 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
|
261 ## |
0a158dbdb04a
Remove 3 unused warning ids
Rik <octave@nomad.inbox5.com>
parents:
12845
diff
changeset
|
262 ## @item Octave:mixed-string-concat |
0a158dbdb04a
Remove 3 unused warning ids
Rik <octave@nomad.inbox5.com>
parents:
12845
diff
changeset
|
263 ## 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
|
264 ## 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
|
265 ## 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
|
266 ## |
24963
2e4ed4250e52
warning_ids.m: alphabetic order nearly-singular-matrix
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
24534
diff
changeset
|
267 ## @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
|
268 ## @itemx Octave:singular-matrix |
26577
ae1542fb58ba
documentation: Avoid some overfull lines in the PDF manual.
Markus Mützel <markus.muetzel@gmx.de>
parents:
26575
diff
changeset
|
269 ## These warnings are emitted if a (nearly) singular matrix is inverted. |
24963
2e4ed4250e52
warning_ids.m: alphabetic order nearly-singular-matrix
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
24534
diff
changeset
|
270 ## 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
|
271 ## @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
|
272 ## |
5781 | 273 ## @item Octave:neg-dim-as-zero |
274 ## If the @code{Octave:neg-dim-as-zero} warning is enabled, print a warning | |
275 ## for expressions like | |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
276 ## |
5781 | 277 ## @example |
278 ## eye (-1) | |
279 ## @end example | |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
280 ## |
5781 | 281 ## @noindent |
282 ## 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
|
283 ## |
13842
4aadd3e2c5bc
warning_ids.m: Add missing warnings to list. They are not documented.
Rik <octave@nomad.inbox5.com>
parents:
13841
diff
changeset
|
284 ## @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
|
285 ## 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
|
286 ## |
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: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
|
288 ## 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
|
289 ## |
5781 | 290 ## @item Octave:num-to-str |
291 ## If the @code{Octave:num-to-str} warning is enable, a warning is | |
26575
3e7fa894731a
documentation: Replace ASCII with UTF-8 where it is more correct.
Markus Mützel <markus.muetzel@gmx.de>
parents:
26376
diff
changeset
|
292 ## printed for implicit conversions of numbers to their UTF-8 encoded character |
5781 | 293 ## equivalents when strings are constructed using a mixture of strings and |
294 ## 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
|
295 ## |
5781 | 296 ## @example |
297 ## @group | |
298 ## [ "f", 111, 111 ] | |
14327
4d917a6a858b
doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
299 ## @result{} "foo" |
5781 | 300 ## @end group |
301 ## @end example | |
10821
693e22af08ae
Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents:
9051
diff
changeset
|
302 ## |
10846
a4f482e66b65
Grammarcheck more of the documentation.
Rik <octave@nomad.inbox5.com>
parents:
10821
diff
changeset
|
303 ## @noindent |
5781 | 304 ## elicits a warning if the @code{Octave:num-to-str} warning is |
305 ## 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
|
306 ## |
12477
d1466d956d17
Add a warning description for Matlab-style short-circuiting
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
11587
diff
changeset
|
307 ## @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
|
308 ## 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
|
309 ## 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
|
310 ## 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
|
311 ## 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
|
312 ## circuit when used in a condition. |
13841
0a158dbdb04a
Remove 3 unused warning ids
Rik <octave@nomad.inbox5.com>
parents:
12845
diff
changeset
|
313 ## 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
|
314 ## is enabled. |
12477
d1466d956d17
Add a warning description for Matlab-style short-circuiting
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
11587
diff
changeset
|
315 ## |
5781 | 316 ## @item Octave:precedence-change |
317 ## If the @code{Octave:precedence-change} warning is enabled, Octave | |
318 ## will warn about possible changes in the meaning of some code due to | |
319 ## 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
|
320 ## typically been made for @sc{matlab} compatibility. |
0a158dbdb04a
Remove 3 unused warning ids
Rik <octave@nomad.inbox5.com>
parents:
12845
diff
changeset
|
321 ## 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
|
322 ## |
13842
4aadd3e2c5bc
warning_ids.m: Add missing warnings to list. They are not documented.
Rik <octave@nomad.inbox5.com>
parents:
13841
diff
changeset
|
323 ## @item Octave: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
|
324 ## 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
|
325 ## |
15605
80a4ded6b89c
warning_ids.m: Add 2 missing warning IDs to documentation.
Rik <rik@octave.org>
parents:
14366
diff
changeset
|
326 ## @item Octave:remove-init-dir |
80a4ded6b89c
warning_ids.m: Add 2 missing warning IDs to documentation.
Rik <rik@octave.org>
parents:
14366
diff
changeset
|
327 ## 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
|
328 ## 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
|
329 ## 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
|
330 ## @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
|
331 ## 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
|
332 ## Octave unworkable. |
80a4ded6b89c
warning_ids.m: Add 2 missing warning IDs to documentation.
Rik <rik@octave.org>
parents:
14366
diff
changeset
|
333 ## 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
|
334 ## |
5781 | 335 ## @item Octave:reload-forces-clear |
336 ## If several functions have been loaded from the same file, Octave must | |
337 ## clear all the functions before any one of them can be reloaded. If | |
338 ## the @code{Octave:reload-forces-clear} warning is enabled, Octave will | |
339 ## 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
|
340 ## functions that it is forced to clear. |
0a158dbdb04a
Remove 3 unused warning ids
Rik <octave@nomad.inbox5.com>
parents:
12845
diff
changeset
|
341 ## 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
|
342 ## |
5781 | 343 ## @item Octave:resize-on-range-error |
344 ## If the @code{Octave:resize-on-range-error} warning is enabled, print a | |
345 ## 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
|
346 ## 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
|
347 ## 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
|
348 ## |
5794 | 349 ## @item Octave:separator-insert |
350 ## Print warning if commas or semicolons might be inserted | |
351 ## automatically in literal matrices. | |
13841
0a158dbdb04a
Remove 3 unused warning ids
Rik <octave@nomad.inbox5.com>
parents:
12845
diff
changeset
|
352 ## 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
|
353 ## |
13842
4aadd3e2c5bc
warning_ids.m: Add missing warnings to list. They are not documented.
Rik <octave@nomad.inbox5.com>
parents:
13841
diff
changeset
|
354 ## @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
|
355 ## 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
|
356 ## |
5794 | 357 ## @item Octave:single-quote-string |
8325
b93ac0586e4b
spelling corrections
Brian Gough<bjg@network-theory.co.uk>
parents:
7017
diff
changeset
|
358 ## Print warning if a single quote character is used to introduce a |
5794 | 359 ## string constant. |
13841
0a158dbdb04a
Remove 3 unused warning ids
Rik <octave@nomad.inbox5.com>
parents:
12845
diff
changeset
|
360 ## 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
|
361 ## |
13842
4aadd3e2c5bc
warning_ids.m: Add missing warnings to list. They are not documented.
Rik <octave@nomad.inbox5.com>
parents:
13841
diff
changeset
|
362 ## @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
|
363 ## 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
|
364 ## |
5781 | 365 ## @item Octave:str-to-num |
366 ## If the @code{Octave:str-to-num} warning is enabled, a warning is printed | |
26575
3e7fa894731a
documentation: Replace ASCII with UTF-8 where it is more correct.
Markus Mützel <markus.muetzel@gmx.de>
parents:
26376
diff
changeset
|
367 ## for implicit conversions of strings to their numeric UTF-8 encoded byte |
3e7fa894731a
documentation: Replace ASCII with UTF-8 where it is more correct.
Markus Mützel <markus.muetzel@gmx.de>
parents:
26376
diff
changeset
|
368 ## sequences. For example, |
10821
693e22af08ae
Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents:
9051
diff
changeset
|
369 ## |
5781 | 370 ## @example |
371 ## @group | |
372 ## "abc" + 0 | |
14327
4d917a6a858b
doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
373 ## @result{} 97 98 99 |
5781 | 374 ## @end group |
375 ## @end example | |
10821
693e22af08ae
Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents:
9051
diff
changeset
|
376 ## |
10846
a4f482e66b65
Grammarcheck more of the documentation.
Rik <octave@nomad.inbox5.com>
parents:
10821
diff
changeset
|
377 ## @noindent |
5781 | 378 ## elicits a warning if the @code{Octave:str-to-num} warning is enabled. |
379 ## 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
|
380 ## |
27062
ffdfeb835aef
warning_ids.m: Add docstring for new "Octave:empty-index" ID (bug #56167).
Rik <rik@octave.org>
parents:
26935
diff
changeset
|
381 ## @item Octave:text_interpreter |
ffdfeb835aef
warning_ids.m: Add docstring for new "Octave:empty-index" ID (bug #56167).
Rik <rik@octave.org>
parents:
26935
diff
changeset
|
382 ## If the @code{Octave:text_interpreter} warning is enabled, a warning is |
ffdfeb835aef
warning_ids.m: Add docstring for new "Octave:empty-index" ID (bug #56167).
Rik <rik@octave.org>
parents:
26935
diff
changeset
|
383 ## printed when the @qcode{"interpreter"} property of a text graphics object |
ffdfeb835aef
warning_ids.m: Add docstring for new "Octave:empty-index" ID (bug #56167).
Rik <rik@octave.org>
parents:
26935
diff
changeset
|
384 ## is set to the unsupported value of @qcode{"latex"}. Even when enabled, |
ffdfeb835aef
warning_ids.m: Add docstring for new "Octave:empty-index" ID (bug #56167).
Rik <rik@octave.org>
parents:
26935
diff
changeset
|
385 ## the warning message is printed just once per Octave session. |
ffdfeb835aef
warning_ids.m: Add docstring for new "Octave:empty-index" ID (bug #56167).
Rik <rik@octave.org>
parents:
26935
diff
changeset
|
386 ## By default, the @code{Octave:glyph-render} warning is enabled. |
ffdfeb835aef
warning_ids.m: Add docstring for new "Octave:empty-index" ID (bug #56167).
Rik <rik@octave.org>
parents:
26935
diff
changeset
|
387 ## |
5781 | 388 ## @item Octave:variable-switch-label |
389 ## If the @code{Octave:variable-switch-label} warning is enabled, Octave | |
390 ## 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
|
391 ## expression. |
0a158dbdb04a
Remove 3 unused warning ids
Rik <octave@nomad.inbox5.com>
parents:
12845
diff
changeset
|
392 ## By default, the @code{Octave:variable-switch-label} warning is disabled. |
5781 | 393 ## @end table |
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17097
diff
changeset
|
394 ## |
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17097
diff
changeset
|
395 |
8673
9e0f0a7bf858
warning_ids.m: make it a function that just calls help
John W. Eaton <jwe@octave.org>
parents:
8325
diff
changeset
|
396 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
|
397 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
|
398 endfunction |
12845
29d4b27e485d
Remove warning_ids.m from test statistics.
Rik <octave@nomad.inbox5.com>
parents:
12576
diff
changeset
|
399 |
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14327
diff
changeset
|
400 |
19192
8a8a7bc2a09d
Improve docstrings and mark documentation m-files as tested in miscellaneous/ dir.
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
401 ## 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
|
402 %!assert (1) |