#14880: Fix kwargs notation in csv.reader, .writer & .register_dialect
Patch by Chris Rebert.
This commit is contained in:
parent
8662c84ac8
commit
7d978902d0
|
@ -57,7 +57,7 @@ Module Contents
|
|||
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 @@ The :mod:`csv` module defines the following functions:
|
|||
*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 @@ The :mod:`csv` module defines the following functions:
|
|||
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 @@ The :mod:`csv` module defines the following functions:
|
|||
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 @@ The :mod:`csv` module defines the following functions:
|
|||
>>> 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`.
|
||||
|
||||
|
|
Loading…
Reference in New Issue