Mercurial > octave-nkf

changeset 12448:f2c080bbd8a5

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Fix documentation bugs uncovered while rewriting munge-texi. Add missing commas to @seealso macro calls for some script functions. Remove @DOCSTRING references to functions without help text references.
author Rik <octave@nomad.inbox5.com>
date Mon, 14 Feb 2011 17:23:04 -0800
parents 890e89c3dfeb
children 2f0d1e12806d
files doc/ChangeLog doc/interpreter/arith.txi doc/interpreter/io.txi doc/interpreter/oop.txi scripts/ChangeLog scripts/plot/semilogxerr.m scripts/plot/semilogyerr.m scripts/special-matrix/pascal.m scripts/special-matrix/rosser.m scripts/special-matrix/wilkinson.m
diffstat 10 files changed, 22 insertions(+), 18 deletions(-) [+]
line wrap: on
line diff
--- a/doc/ChangeLog	Tue Feb 15 01:28:11 2011 +0100
+++ b/doc/ChangeLog	Mon Feb 14 17:23:04 2011 -0800
@@ -1,3 +1,8 @@
+2010-02-14  Rik  <octave@nomad.inbox5.com>
+
+	* interpreter/arith.txi, interpreter/io.txi, interpreter/oop.txi:
+	Remove functions which have no DOCSTRING entries.
+
 2011-02-06  John W. Eaton  <jwe@octave.org>
 
 	* interpreter/contributors.in: Add Fotios Kasolis to the list.
--- a/doc/interpreter/arith.txi	Tue Feb 15 01:28:11 2011 +0100
+++ b/doc/interpreter/arith.txi	Mon Feb 14 17:23:04 2011 -0800
@@ -214,8 +214,6 @@
 
 @DOCSTRING(floor)
 
-@DOCSTRING(fmod)
-
 @DOCSTRING(gcd)
 
 @DOCSTRING(gradient)
--- a/doc/interpreter/io.txi	Tue Feb 15 01:28:11 2011 +0100
+++ b/doc/interpreter/io.txi	Mon Feb 14 17:23:04 2011 -0800
@@ -997,8 +997,6 @@
 
 @DOCSTRING(tmpnam)
 
-@DOCSTRING(octave_tmp_file_name)
-
 @node EOF and Errors, File Positioning, Temporary Files, C-Style I/O Functions
 @subsection End of File and Errors
 
--- a/doc/interpreter/oop.txi	Tue Feb 15 01:28:11 2011 +0100
+++ b/doc/interpreter/oop.txi	Mon Feb 14 17:23:04 2011 -0800
@@ -299,11 +299,8 @@
 
 If you wish to use the @code{end} keyword in subscripted expressions
 of an object, then the user needs to define the @code{end} method for 
-the class.
-
-@DOCSTRING(end)
-
-For example the @code{end} method for our polynomial class might look like
+the class.  For example, the @code{end} method for our polynomial class might
+look like
 
 @example
 @group
@@ -313,8 +310,8 @@
 
 @noindent
 which is a fairly generic @code{end} method that has a behavior similar to
-the @code{end} keyword for Octave Array classes.  It can then be used for
-example like
+the @code{end} keyword for Octave Array classes.  It can then be used as 
+follows:
 
 @example
 @group
--- a/scripts/ChangeLog	Tue Feb 15 01:28:11 2011 +0100
+++ b/scripts/ChangeLog	Mon Feb 14 17:23:04 2011 -0800
@@ -1,3 +1,9 @@
+2010-02-14  Rik  <octave@nomad.inbox5.com>
+
+	* plot/semilogxerr.m, plot/semilogyerr.m, special-matrix/pascal.m,
+	special-matrix/rosser.m, special-matrix/wilkinson.m: Add missing
+	commas in @seealso macro.
+
 2011-02-14  David Bateman  <dbateman@free.fr>
 
 	* testfun/test.m: More explicit error message when source of a
--- a/scripts/plot/semilogxerr.m	Tue Feb 15 01:28:11 2011 +0100
+++ b/scripts/plot/semilogxerr.m	Mon Feb 14 17:23:04 2011 -0800
@@ -31,7 +31,7 @@
 ## with errors in the @var{y}-scale defined by @var{ey} and the plot
 ## format defined by @var{fmt}.  See @code{errorbar} for available formats and
 ## additional information.
-## @seealso{errorbar, loglogerr semilogyerr}
+## @seealso{errorbar, loglogerr, semilogyerr}
 ## @end deftypefn
 
 ## Created: 20.2.2001
--- a/scripts/plot/semilogyerr.m	Tue Feb 15 01:28:11 2011 +0100
+++ b/scripts/plot/semilogyerr.m	Mon Feb 14 17:23:04 2011 -0800
@@ -31,7 +31,7 @@
 ## with errors in the @var{y}-scale defined by @var{ey} and the plot
 ## format defined by @var{fmt}.  See @code{errorbar} for available formats and
 ## additional information.
-## @seealso{errorbar, loglogerr semilogxerr}
+## @seealso{errorbar, loglogerr, semilogxerr}
 ## @end deftypefn
 
 ## Created: 20.2.2001
--- a/scripts/special-matrix/pascal.m	Tue Feb 15 01:28:11 2011 +0100
+++ b/scripts/special-matrix/pascal.m	Mon Feb 14 17:23:04 2011 -0800
@@ -30,7 +30,7 @@
 ## @code{pascal (@var{n}, 1)}, which is the cube-root of the identity
 ## matrix.  That is @code{pascal (@var{n}, 2) ^ 3 == eye (@var{n})}.
 ##
-## @seealso{hankel, vander, sylvester_matrix, hilb, invhilb, toeplitz
+## @seealso{hankel, vander, sylvester_matrix, hilb, invhilb, toeplitz,
 ##          hadamard, wilkinson, compan, rosser}
 ## @end deftypefn
 
--- a/scripts/special-matrix/rosser.m	Tue Feb 15 01:28:11 2011 +0100
+++ b/scripts/special-matrix/rosser.m	Mon Feb 14 17:23:04 2011 -0800
@@ -21,7 +21,7 @@
 ## Return the Rosser matrix.  This is a difficult test case used to evaluate
 ## eigenvalue algorithms.
 ##
-## @seealso{hankel, vander, sylvester_matrix, hilb, invhilb, toeplitz
+## @seealso{hankel, vander, sylvester_matrix, hilb, invhilb, toeplitz,
 ##          hadamard, wilkinson, compan, pascal}
 ## @end deftypefn
 
--- a/scripts/special-matrix/wilkinson.m	Tue Feb 15 01:28:11 2011 +0100
+++ b/scripts/special-matrix/wilkinson.m	Mon Feb 14 17:23:04 2011 -0800
@@ -22,8 +22,8 @@
 ## symmetric and tridiagonal with pairs of nearly, but not exactly, equal
 ## eigenvalues.
 ##
-## @seealso{hankel, vander, sylvester_matrix, hilb, invhilb, toeplitz
-##           hadamard, rosser, compan, pascal}
+## @seealso{hankel, vander, sylvester_matrix, hilb, invhilb, toeplitz,
+##          hadamard, rosser, compan, pascal}
 ## @end deftypefn
 
 ## Author: Peter Ekberg
@@ -50,4 +50,4 @@
 %!assert (wilkinson(3), [1,1,0;1,0,1;0,1,1])
 %!assert (wilkinson(4), [1.5,1,0,0;1,0.5,1,0;0,1,0.5,1;0,0,1,1.5])
 %!error (wilkinson())
-%!error (wilkinson(1,2))
\ No newline at end of file
+%!error (wilkinson(1,2))