changeset 12973:b80b18f537ca

doc: Correct various Texinfo warnings about incorrect use of macros. * install.txi: Change @strong{Note:} to @strong{Note}: to move colon outside of macro. * edit.m: Change "WARNING!" to "Warning:" for consistency with other instances. * wilcoxon_test.m: Change "Warning:" to "Caution:" to more accurately reflect level of concern. * strmatch.m: Change @strong{Note:} to @strong{Caution:} to stop spurious cross-reference creation. * datenum.m: Change "Warning:" to "Caution:" to more accurately reflect level of concern. * oct-parse.yy: Change @xref to an @pxref to suppress warning about incorrect usage.
author Rik <octave@nomad.inbox5.com>
date Tue, 16 Aug 2011 10:03:33 -0700
parents e4f82a337d66
children 6590446c2498
files doc/interpreter/install.txi scripts/miscellaneous/edit.m scripts/statistics/tests/wilcoxon_test.m scripts/strings/strmatch.m scripts/time/datenum.m src/oct-parse.yy
diffstat 6 files changed, 8 insertions(+), 8 deletions(-) [+]
line wrap: on
line diff
--- a/doc/interpreter/install.txi
+++ b/doc/interpreter/install.txi
@@ -32,7 +32,7 @@
 under the terms of the GNU General Public License as published by the
 Free Software Foundation.
 
-@strong{Note:} This file is automatically generated from
+@strong{Note}: This file is automatically generated from
 @file{doc/interpreter/install.txi} in the Octave sources.  To update
 the documentation make changes to the .txi source file rather than this
 derived file.
--- a/scripts/miscellaneous/edit.m
+++ b/scripts/miscellaneous/edit.m
@@ -54,7 +54,7 @@
 ## filename.  If @file{name.ext} is not modifiable, it will be copied to
 ## @env{HOME} before editing.
 ##
-## @strong{WARNING!} You may need to clear name before the new definition
+## @strong{Warning:} You may need to clear name before the new definition
 ## is available.  If you are editing a .cc file, you will need
 ## to mkoctfile @file{name.cc} before the definition will be available.
 ## @end itemize
--- a/scripts/statistics/tests/wilcoxon_test.m
+++ b/scripts/statistics/tests/wilcoxon_test.m
@@ -23,7 +23,7 @@
 ## @var{y}) == 1/2.  Under the null, the test statistic @var{z}
 ## approximately follows a standard normal distribution when @var{n} > 25.
 ##
-## @strong{Warning}: This function assumes a normal distribution for @var{z}
+## @strong{Caution:} This function assumes a normal distribution for @var{z}
 ## and thus is invalid for @var{n} @leq{} 25.
 ##
 ## With the optional argument string @var{alt}, the alternative of
--- a/scripts/strings/strmatch.m
+++ b/scripts/strings/strmatch.m
@@ -43,7 +43,7 @@
 ## @end group
 ## @end example
 ##
-## @strong{Note:} @code{strmatch} is scheduled for deprecation.  Use
+## @strong{Caution:} @code{strmatch} is scheduled for deprecation.  Use
 ## @code{strcmpi} or @code{strncmpi} in all new code.
 ## @seealso{strfind, findstr, strcmp, strncmp, strcmpi, strncmpi, find}
 ## @end deftypefn
--- a/scripts/time/datenum.m
+++ b/scripts/time/datenum.m
@@ -50,7 +50,7 @@
 ## Days can be fractional.
 ## @end itemize
 ##
-## @strong{Warning:} this function does not attempt to handle Julian
+## @strong{Caution:} this function does not attempt to handle Julian
 ## calendars so dates before Octave 15, 1582 are wrong by as much
 ## as eleven days.  Also be aware that only Roman Catholic countries
 ## adopted the calendar in 1582.  It took until 1924 for it to be
--- a/src/oct-parse.yy
+++ b/src/oct-parse.yy
@@ -4216,10 +4216,10 @@
 calls the function @code{acos} with the argument @samp{-1}.\n\
 \n\
 The function @code{feval} can also be used with function handles of\n\
-any sort. @xref{Function Handles} Historically, @code{feval} was\n\
+any sort (@pxref{Function Handles}).  Historically, @code{feval} was\n\
 the only way to call user-supplied functions in strings, but\n\
 function handles are now preferred due to the cleaner syntax they\n\
-offer. For example,\n\
+offer.  For example,\n\
 \n\
 @example\n\
 @group\n\
@@ -4232,7 +4232,7 @@
 @end example\n\
 \n\
 @noindent\n\
-are equivalent ways to call the function referred to by @var{f}. If it\n\
+are equivalent ways to call the function referred to by @var{f}.  If it\n\
 cannot be predicted beforehand that @var{f} is a function handle or the\n\
 function name in a string, @code{feval} can be used instead.\n\
 @end deftypefn")