[Python-checkins] cpython (3.3): #20628: make it clear that DictReader/Writer *fieldnames* is a Sequence.

[r.david.murray]

http://hg.python.org/cpython/rev/a5d4660c6cb6
changeset:   89374:a5d4660c6cb6
branch:      3.3
parent:      89372:151a498c55e3
user:        R David Murray <rdmurray at bitdance.com>
date:        Mon Feb 24 15:29:22 2014 -0500
summary:
  #20628: make it clear that DictReader/Writer *fieldnames* is a Sequence.

Patch by Sean Rodman.

files:
  Doc/library/csv.rst |  8 ++++++--
  1 files changed, 6 insertions(+), 2 deletions(-)


diff --git a/Doc/library/csv.rst b/Doc/library/csv.rst
--- a/Doc/library/csv.rst
+++ b/Doc/library/csv.rst
@@ -145,7 +145,10 @@
 .. class:: DictReader(csvfile, fieldnames=None, restkey=None, restval=None, dialect='excel', *args, **kwds)
 
    Create an object which operates like a regular reader but maps the information
-   read into a dict whose keys are given by the optional  *fieldnames* parameter.
+   read into a dict whose keys are given by the optional *fieldnames* parameter.
+   The *fieldnames* parameter is a :mod:`sequence <collections.abc>` whose elements
+   are associated with the fields of the input data in order. These elements
+   become the keys of the resulting dictionary.
    If the *fieldnames* parameter is omitted, the values in the first row of the
    *csvfile* will be used as the fieldnames.  If the row read has more fields
    than the fieldnames sequence, the remaining data is added as a sequence
@@ -158,7 +161,8 @@
 .. class:: DictWriter(csvfile, fieldnames, restval='', extrasaction='raise', dialect='excel', *args, **kwds)
 
    Create an object which operates like a regular writer but maps dictionaries onto
-   output rows.  The *fieldnames* parameter identifies the order in which values in
+   output rows.  The *fieldnames* parameter is a :mod:`sequence
+   <collections.abc>` of keys that identify the order in which values in
    the dictionary passed to the :meth:`writerow` method are written to the
    *csvfile*.  The optional *restval* parameter specifies the value to be written
    if the dictionary is missing a key in *fieldnames*.  If the dictionary passed to

-- 
Repository URL: http://hg.python.org/cpython