summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorpierregm <pierregm@localhost>2009-11-07 10:10:19 +0000
committerpierregm <pierregm@localhost>2009-11-07 10:10:19 +0000
commitca35f530266c73ed32b7d7e35720151c49426554 (patch)
tree7da057a69b8d9c411ab4789e4cec312ce202fd9f
parent7e853ef0b210f8297a15a03f257ff268a78c5c1a (diff)
downloadnumpy-ca35f530266c73ed32b7d7e35720151c49426554.tar.gz
docs : renamed basic.io.rst and basic.io.genfromtxt to basics.io and basics.io.genfromtxt
io.genfromtxt : update the doc
-rw-r--r--doc/source/user/basics.io.genfromtxt.rst (renamed from doc/source/user/basic.io.genfromtxt.rst)0
-rw-r--r--doc/source/user/basics.io.rst (renamed from doc/source/user/basic.io.rst)3
-rw-r--r--doc/source/user/basics.rst1
-rw-r--r--numpy/lib/io.py34
4 files changed, 15 insertions, 23 deletions
diff --git a/doc/source/user/basic.io.genfromtxt.rst b/doc/source/user/basics.io.genfromtxt.rst
index 28130b311..28130b311 100644
--- a/doc/source/user/basic.io.genfromtxt.rst
+++ b/doc/source/user/basics.io.genfromtxt.rst
diff --git a/doc/source/user/basic.io.rst b/doc/source/user/basics.io.rst
index 54ef758d5..73947a2ef 100644
--- a/doc/source/user/basic.io.rst
+++ b/doc/source/user/basics.io.rst
@@ -3,5 +3,6 @@ I/O with Numpy
**************
.. toctree::
+ :maxdepth: 2
- basic.io.genfromtxt \ No newline at end of file
+ basics.io.genfromtxt \ No newline at end of file
diff --git a/doc/source/user/basics.rst b/doc/source/user/basics.rst
index 03f0a1d85..85e79c25d 100644
--- a/doc/source/user/basics.rst
+++ b/doc/source/user/basics.rst
@@ -8,6 +8,7 @@ Numpy basics
and "Guide to Numpy" chapter 2. Needs combining?
.. toctree::
+ :maxdepth: 2
basics.types
basics.creation
diff --git a/numpy/lib/io.py b/numpy/lib/io.py
index 258e86976..262d20dd9 100644
--- a/numpy/lib/io.py
+++ b/numpy/lib/io.py
@@ -888,12 +888,7 @@ def genfromtxt(fname, dtype=float, comments='#', delimiter=None,
File or filename to read. If the filename extension is `.gz` or
`.bz2`, the file is first decompressed.
dtype : dtype, optional
- Data type of the resulting array. If this is a structured data type,
- the resulting array will be 1-dimensional, and each row will be
- interpreted as an element of the array. In this case, the number
- of columns used must match the number of fields in the data-type,
- and the names of each field will be set by the corresponding name
- of the dtype.
+ Data type of the resulting array.
If None, the dtypes will be determined by the contents of each
column, individually.
comments : str, optional
@@ -903,23 +898,18 @@ def genfromtxt(fname, dtype=float, comments='#', delimiter=None,
The string used to separate values. By default, any consecutive
whitespaces act as delimiter. An integer or sequence of integers
can also be provided as width(s) of each field.
- skiprows : int, optional
- Numbers of lines to skip at the beginning of the file.
- The use of skiprows is deprecated: use `skip_header` instead.
skip_header : int, optional
- Numbers of lines to skip at the beginning of the file.
- converters : dict or None, optional
- A dictionary mapping column number to a function that will convert
- values in the column to a number. Converters can also be used to
- provide a default value for missing data:
- ``converters = {3: lambda s: float(s or 0)}``.
- missing : str, optional
- A string representing a missing value, irrespective of the column where
- it appears (e.g., `'missing'` or `'unused'`).
- The use of `missing` is deprecated, use `missing_values` instead.
- missing_values : dict or None, optional
- A dictionary mapping a column number to a string indicating whether the
- corresponding field should be masked.
+ The numbers of lines to skip at the beginning of the file.
+ skip_footer : int, optional
+ The numbers of lines to skip at the end of the file
+ converters : variable or None, optional
+ The set of functions that convert the data of a column to a value.
+ The converters can also be used to provide a default value
+ for missing data: ``converters = {3: lambda s: float(s or 0)}``.
+ missing_values : variable or None, optional
+ The set of strings corresponding to missing data.
+ filling_values : variable or None, optional
+ The set of values to be used as default when the data are missing.
usecols : sequence or None, optional
Which columns to read, with 0 being the first. For example,
``usecols = (1, 4, 5)`` will extract the 2nd, 5th and 6th columns.