[Python-checkins] cpython (2.7): #14880: Fix kwargs notation in csv.reader, .writer & .register_dialect

[hynek.schlawack]

http://hg.python.org/cpython/rev/dc080e19f7aa
changeset:   78782:dc080e19f7aa
branch:      2.7
parent:      78774:92aa438a5c4b
user:        Hynek Schlawack <hs at ox.cx>
date:        Tue Aug 28 12:33:46 2012 +0200
summary:
  #14880: Fix kwargs notation in csv.reader, .writer & .register_dialect

Patch by Chris Rebert.

files:
  Doc/library/csv.rst |  12 ++++++------
  Misc/NEWS           |   3 +++
  2 files changed, 9 insertions(+), 6 deletions(-)


diff --git a/Doc/library/csv.rst b/Doc/library/csv.rst
--- a/Doc/library/csv.rst
+++ b/Doc/library/csv.rst
@@ -57,7 +57,7 @@
 The :mod:`csv` module defines the following functions:
 
 
-.. function:: reader(csvfile[, dialect='excel'][, fmtparam])
+.. function:: reader(csvfile, dialect='excel', **fmtparams)
 
    Return a reader object which will iterate over lines in the given *csvfile*.
    *csvfile* can be any object which supports the :term:`iterator` protocol and returns a
@@ -67,7 +67,7 @@
    *dialect* parameter can be given which is used to define a set of parameters
    specific to a particular CSV dialect.  It may be an instance of a subclass of
    the :class:`Dialect` class or one of the strings returned by the
-   :func:`list_dialects` function.  The other optional *fmtparam* keyword arguments
+   :func:`list_dialects` function.  The other optional *fmtparams* keyword arguments
    can be given to override individual formatting parameters in the current
    dialect.  For full details about the dialect and formatting parameters, see
    section :ref:`csv-fmt-params`.
@@ -94,7 +94,7 @@
       be split into lines in a manner which preserves the newline characters.
 
 
-.. function:: writer(csvfile[, dialect='excel'][, fmtparam])
+.. function:: writer(csvfile, dialect='excel', **fmtparams)
 
    Return a writer object responsible for converting the user's data into delimited
    strings on the given file-like object.  *csvfile* can be any object with a
@@ -103,7 +103,7 @@
    parameter can be given which is used to define a set of parameters specific to a
    particular CSV dialect.  It may be an instance of a subclass of the
    :class:`Dialect` class or one of the strings returned by the
-   :func:`list_dialects` function.  The other optional *fmtparam* keyword arguments
+   :func:`list_dialects` function.  The other optional *fmtparams* keyword arguments
    can be given to override individual formatting parameters in the current
    dialect.  For full details about the dialect and formatting parameters, see
    section :ref:`csv-fmt-params`. To make it
@@ -122,11 +122,11 @@
       >>> spamWriter.writerow(['Spam', 'Lovely Spam', 'Wonderful Spam'])
 
 
-.. function:: register_dialect(name[, dialect][, fmtparam])
+.. function:: register_dialect(name[, dialect], **fmtparams)
 
    Associate *dialect* with *name*.  *name* must be a string or Unicode object. The
    dialect can be specified either by passing a sub-class of :class:`Dialect`, or
-   by *fmtparam* keyword arguments, or both, with keyword arguments overriding
+   by *fmtparams* keyword arguments, or both, with keyword arguments overriding
    parameters of the dialect. For full details about the dialect and formatting
    parameters, see section :ref:`csv-fmt-params`.
 
diff --git a/Misc/NEWS b/Misc/NEWS
--- a/Misc/NEWS
+++ b/Misc/NEWS
@@ -378,6 +378,9 @@
 Documentation
 -------------
 
+- Issue #14880: Fix kwargs notation in csv.reader, .writer & .register_dialect.
+  Patch by Chris Rebert.
+
 - Issue #14674: Add a discussion of the json module's standard compliance.
   Patch by Chris Rebert.
 

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