summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorYaron de Leeuw <jarondl@server.fake>2014-02-27 20:13:03 +0200
committerYaron de Leeuw <jarondl@server.fake>2014-02-28 09:22:08 +0200
commit39f11331744aeb6d8e8cd3c557a1e107d0dac816 (patch)
tree8ff5bd6bdbafc64990261afb6af34add5d812862
parent3b99f376c9e2d128291c16a896a4b302b75020c1 (diff)
downloadnumpy-39f11331744aeb6d8e8cd3c557a1e107d0dac816.tar.gz
DOC: npyio.recfromcsv keyword argument changes
Added a note to recfromcsv about the `dtype` keyword, as suggested by @hpaulj. Also added a note to the release notes, about the change in the `update` keyword, as suggested by @charris.
-rw-r--r--doc/release/1.9.0-notes.rst6
-rw-r--r--numpy/lib/npyio.py5
2 files changed, 11 insertions, 0 deletions
diff --git a/doc/release/1.9.0-notes.rst b/doc/release/1.9.0-notes.rst
index d674552a3..c65cfc04c 100644
--- a/doc/release/1.9.0-notes.rst
+++ b/doc/release/1.9.0-notes.rst
@@ -207,6 +207,12 @@ is being casted. Previously the casting was allowed even if the result was
truncated.
+`npyio.recfromcsv` keyword arguments change
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+`npyio.recfromcsv` no longer accepts the undocumented `update` keyword,
+which used to override the `dtype` keyword.
+
+
C-API
~~~~~
diff --git a/numpy/lib/npyio.py b/numpy/lib/npyio.py
index 341008c9e..84d4c35bd 100644
--- a/numpy/lib/npyio.py
+++ b/numpy/lib/npyio.py
@@ -1871,6 +1871,11 @@ def recfromcsv(fname, **kwargs):
--------
numpy.genfromtxt : generic function to load ASCII data.
+ Notes
+ -----
+ By default, `dtype` is None, which means that the data-type of the output
+ array will be determined from the data.
+
"""
# Set default kwargs as relevant to csv import.
# These seem to be undocumented. (case_sensitive is mentioned in basics.io)