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