Mercurial > octave

changeset 25179:3ae57b161ab4 stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Document warning ID Octave:data-file-in-path (bug #53588) * basics.txi: Change occurrences of warning IDs XXX-file-in-path to data-file-in-path. * warning_ids.m: Document Octave:data-file-in-path. Remove warning ID Octave:fopen-file-in-path, Octave:load-file-in-path.
author Rik <rik@octave.org>
date Mon, 09 Apr 2018 09:32:39 -0700
parents 4e79e324f441
children e25b8fda2a51 27fe7e6aba31
files doc/interpreter/basics.txi scripts/help/warning_ids.m
diffstat 2 files changed, 7 insertions(+), 6 deletions(-) [+]
line wrap: on
line diff
--- a/doc/interpreter/basics.txi	Mon Apr 09 00:31:48 2018 -0500
+++ b/doc/interpreter/basics.txi	Mon Apr 09 09:32:39 2018 -0700
@@ -267,9 +267,8 @@
 @example
 @group
 Octave:abbreviated-property-match
-Octave:fopen-file-in-path
+Octave:data-file-in-path
 Octave:function-name-clash
-Octave:load-file-in-path
 Octave:possible-matlab-short-circuit-operator
 @end group
 @end example
--- a/scripts/help/warning_ids.m	Mon Apr 09 00:31:48 2018 -0500
+++ b/scripts/help/warning_ids.m	Mon Apr 09 09:32:39 2018 -0700
@@ -177,7 +177,12 @@
 ## By default, the @code{Octave:eigs:UnconvergedEigenvalues} warning is
 ## enabled.
 ##
-## @item Octave:fopen-file-in-path
+## @item Octave:data-file-in-path
+## If the @code{Octave:data-file-in-path} warning is enabled, a warning is
+## issued when Octave does not find the target of a file operation such as
+## @code{load} or @code{fopen} directly, but is able to locate the file in
+## Octave's search @code{path} for files.  The warning could indicate that a
+## different file target then the programmer intended is being used.
 ## By default, the @code{Octave:fopen-file-in-path} warning is enabled.
 ##
 ## @item Octave:function-name-clash
@@ -208,9 +213,6 @@
 ## The @option{--traditional} or @option{--braindead} startup options for
 ## Octave may also be of use, @pxref{Command Line Options}.
 ##
-## @item Octave:load-file-in-path
-## By default, the @code{Octave:load-file-in-path} warning is enabled.
-##
 ## @item Octave:logical-conversion
 ## By default, the @code{Octave:logical-conversion} warning is enabled.
 ##