changeset 12175:2090995ca588

Correct en-dash,em-dash instances in docstrings. Add a few more operators to operator index.
author Rik <octave@nomad.inbox5.com>
date Wed, 26 Jan 2011 20:51:20 -0800
parents db1f49eaba6b
children 515446c8fe23
files doc/ChangeLog doc/interpreter/basics.txi doc/interpreter/container.txi scripts/ChangeLog scripts/general/interp1.m scripts/general/interp2.m scripts/general/interp3.m scripts/general/interpn.m scripts/miscellaneous/mkoctfile.m
diffstat 9 files changed, 28 insertions(+), 9 deletions(-) [+]
line wrap: on
line diff
--- a/doc/ChangeLog
+++ b/doc/ChangeLog
@@ -6,6 +6,13 @@
 
 2011-01-26  Rik  <octave@nomad.inbox5.com>
 
+	* interpreter/basics.txi: Use @code to eliminate extra single quotes
+	in index.
+	* interpreter/container.txi: Add @opindex citations for '.', '{' and
+	'}'.
+
+2011-01-26  Rik  <octave@nomad.inbox5.com>
+
 	* interpreter/octave-bug.1: Delete obsolete man page
 	* interpreter/Makefile.am: Stop distributing octave-bug.1 man page.
 
--- a/doc/interpreter/basics.txi
+++ b/doc/interpreter/basics.txi
@@ -674,7 +674,7 @@
 
 @node Customizing readline
 @subsection Customizing @code{readline}
-@cindex @file{~/.inputrc}
+@cindex @code{~/.inputrc}
 @cindex customizing @code{readline}
 @cindex @code{readline} customization
 
--- a/doc/interpreter/container.txi
+++ b/doc/interpreter/container.txi
@@ -66,9 +66,12 @@
 @end group
 @end example
 
+@opindex .
 @noindent
-create a structure with three elements.  To print the value of the
-structure, you can type its name, just as for any other variable:
+create a structure with three elements.  The @samp{.} character separates
+the structure name from the field name and indicates to Octave that this
+variable is a structure.  To print the value of the
+structure you can type its name, just as for any other variable:
 
 @example
 @group
@@ -494,7 +497,8 @@
 
 @node Basic Usage of Cell Arrays
 @subsection Basic Usage of Cell Arrays
-
+@opindex @{
+@opindex @}
 As an example, the following code creates a cell array containing a
 string and a 2-by-2 random matrix
 
--- a/scripts/ChangeLog
+++ b/scripts/ChangeLog
@@ -1,3 +1,11 @@
+2011-01-26  Rik  <octave@nomad.inbox5.com>
+
+	* scripts/general/interp1.m, scripts/general/interp2.m,
+	scripts/general/interp3.m, scripts/general/interpn.m: Use em-dash
+	rather than en-dash.
+	* scripts/miscellaneous/mkoctfile.m: Use @code to prevent option
+	turning to en-dash.
+
 2011-01-26  John W. Eaton  <jwe@octave.org>
 
 	* mkdoc: Untabify.
--- a/scripts/general/interp1.m
+++ b/scripts/general/interp1.m
@@ -46,7 +46,7 @@
 ## Cubic interpolation from four nearest neighbors
 ##
 ## @item 'spline'
-## Cubic spline interpolation--smooth first and second derivatives
+## Cubic spline interpolation---smooth first and second derivatives
 ## throughout the curve
 ## @end table
 ##
--- a/scripts/general/interp2.m
+++ b/scripts/general/interp2.m
@@ -65,7 +65,7 @@
 ## Cubic interpolation from four nearest neighbors.
 ##
 ## @item 'spline'
-## Cubic spline interpolation--smooth first and second derivatives
+## Cubic spline interpolation---smooth first and second derivatives
 ## throughout the curve.
 ## @end table
 ##
--- a/scripts/general/interp3.m
+++ b/scripts/general/interp3.m
@@ -52,7 +52,7 @@
 ## Cubic interpolation from four nearest neighbors (not implemented yet).
 ##
 ## @item 'spline'
-## Cubic spline interpolation--smooth first and second derivatives
+## Cubic spline interpolation---smooth first and second derivatives
 ## throughout the curve.
 ## @end table
 ##
--- a/scripts/general/interpn.m
+++ b/scripts/general/interpn.m
@@ -52,7 +52,7 @@
 ## Cubic interpolation from four nearest neighbors (not implemented yet).
 ##
 ## @item 'spline'
-## Cubic spline interpolation--smooth first and second derivatives
+## Cubic spline interpolation---smooth first and second derivatives
 ## throughout the curve.
 ## @end table
 ##
--- a/scripts/miscellaneous/mkoctfile.m
+++ b/scripts/miscellaneous/mkoctfile.m
@@ -67,7 +67,7 @@
 ## @item -o FILE
 ## @itemx --output FILE
 ## Output file name.  Default extension is .oct
-## (or .mex if --mex is specified) unless linking
+## (or .mex if @samp{--mex} is specified) unless linking
 ## a stand-alone executable.
 ##
 ## @item -p VAR