Argout typemap documentation made more clear.

3 files changed, 9 insertions, 5 deletions

diff --git a/numpy/doc/swig/doc/numpy_swig.html b/numpy/doc/swig/doc/numpy_swig.html
index ded869ac9..ed127f330 100644
--- a/numpy/doc/swig/doc/numpy_swig.html
+++ b/numpy/doc/swig/doc/numpy_swig.html
@@ -651,7 +651,9 @@ and return the sequence.  This is what the argout typemaps do.  If a
 wrapped function that uses these argout typemaps has more than one
 return argument, they are packed into a tuple or list, depending on
 the version of <a class="reference" href="http://www.python.org">python</a>.  The <a class="reference" href="http://www.python.org">python</a> user does not pass these
-arrays in, they simply get returned.  The argout signatures are</p>
+arrays in, they simply get returned.  For the case where a dimension
+is specified, the python user must provide that dimension as an
+argument.  The argout signatures are</p>
 <p>1D:</p>
 <blockquote>
 <ul class="simple">
@@ -677,7 +679,7 @@ allocate a(n) array(s) on the heap, and call the function to fill the
 array(s) values.  In <a class="reference" href="http://www.python.org">python</a>, the arrays are allocated for you and
 returned as new array objects.</p>
 <p>Note that we support <tt class="docutils literal"><span class="pre">DATA_TYPE*</span></tt> argout typemaps in 1D, but not 2D
-or 3D.  This because of a quirk with the <a class="reference" href="http://www.swig.org">SWIG</a> typemap syntax and
+or 3D.  This is because of a quirk with the <a class="reference" href="http://www.swig.org">SWIG</a> typemap syntax and
 cannot be avoided.  Note that for these types of 1D typemaps, the
 <a class="reference" href="http://www.python.org">python</a> function will take a single argument representing <tt class="docutils literal"><span class="pre">DIM1</span></tt>.</p>
 </div>
@@ -1234,7 +1236,7 @@ contributors has made this end result possible.</p>
 </div>
 <div class="footer">
 <hr class="footer" />
-Generated on: 2007-12-01 18:08 UTC.
+Generated on: 2007-12-01 18:17 UTC.
 Generated by <a class="reference" href="http://docutils.sourceforge.net/">Docutils</a> from <a class="reference" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source.
 
 </div>
diff --git a/numpy/doc/swig/doc/numpy_swig.pdf b/numpy/doc/swig/doc/numpy_swig.pdf
index 2cfef5f2f..1d4642cf7 100644
--- a/numpy/doc/swig/doc/numpy_swig.pdf
+++ b/numpy/doc/swig/doc/numpy_swig.pdf
diff --git a/numpy/doc/swig/doc/numpy_swig.txt b/numpy/doc/swig/doc/numpy_swig.txt
index b589f2bf7..bfde018bf 100644
--- a/numpy/doc/swig/doc/numpy_swig.txt
+++ b/numpy/doc/swig/doc/numpy_swig.txt
@@ -325,7 +325,9 @@ and return the sequence.  This is what the argout typemaps do.  If a
 wrapped function that uses these argout typemaps has more than one
 return argument, they are packed into a tuple or list, depending on
 the version of `python`_.  The `python`_ user does not pass these
-arrays in, they simply get returned.  The argout signatures are
+arrays in, they simply get returned.  For the case where a dimension
+is specified, the python user must provide that dimension as an
+argument.  The argout signatures are
 
 1D:
 
@@ -347,7 +349,7 @@ array(s) values.  In `python`_, the arrays are allocated for you and
 returned as new array objects.
 
 Note that we support ``DATA_TYPE*`` argout typemaps in 1D, but not 2D
-or 3D.  This because of a quirk with the `SWIG`_ typemap syntax and
+or 3D.  This is because of a quirk with the `SWIG`_ typemap syntax and
 cannot be avoided.  Note that for these types of 1D typemaps, the
 `python`_ function will take a single argument representing ``DIM1``.