mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-08-19 08:11:46 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

[3.11] gh-101100: Fix references in csv docs (GH-114658) (GH-114773)

Browse source 
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
(cherry picked from commit 3911b42cc0)
This commit is contained in:
Skip Montanaro 2024-01-31 03:32:12 -06:00 • committed by GitHub
parent 48632d22d6
commit a38bc7cad6
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 7 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

14
Doc/library/csv.rst
View file

@ -88,7 +88,7 @@ The :mod:`csv` module defines the following functions:
Return a writer object responsible for converting the user's data into delimited 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 strings on the given file-like object. *csvfile* can be any object with a
:func:`write` method. If *csvfile* is a file object, it should be opened with :meth:`~io.TextIOBase.write` method. If *csvfile* is a file object, it should be opened with
``newline=''`` [1]_. An optional *dialect* ``newline=''`` [1]_. An optional *dialect*
parameter can be given which is used to define a set of parameters specific to a 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 particular CSV dialect. It may be an instance of a subclass of the
@ -195,10 +195,10 @@ The :mod:`csv` module defines the following classes:
Create an object which operates like a regular writer but maps dictionaries Create an object which operates like a regular writer but maps dictionaries
onto output rows. The *fieldnames* parameter is a :mod:`sequence onto output rows. The *fieldnames* parameter is a :mod:`sequence
<collections.abc>` of keys that identify the order in which values in the <collections.abc>` of keys that identify the order in which values in the
dictionary passed to the :meth:`writerow` method are written to file dictionary passed to the :meth:`~csvwriter.writerow` method are written to file
*f*. The optional *restval* parameter specifies the value to be *f*. The optional *restval* parameter specifies the value to be
written if the dictionary is missing a key in *fieldnames*. If the written if the dictionary is missing a key in *fieldnames*. If the
dictionary passed to the :meth:`writerow` method contains a key not found in dictionary passed to the :meth:`~csvwriter.writerow` method contains a key not found in
*fieldnames*, the optional *extrasaction* parameter indicates what action to *fieldnames*, the optional *extrasaction* parameter indicates what action to
take. take.
If it is set to ``'raise'``, the default value, a :exc:`ValueError` If it is set to ``'raise'``, the default value, a :exc:`ValueError`
@ -352,8 +352,8 @@ Dialects and Formatting Parameters
To make it easier to specify the format of input and output records, specific To make it easier to specify the format of input and output records, specific
formatting parameters are grouped together into dialects. A dialect is a formatting parameters are grouped together into dialects. A dialect is a
subclass of the :class:`Dialect` class having a set of specific methods and a subclass of the :class:`Dialect` class containing various attributes
single :meth:`validate` method. When creating :class:`reader` or describing the format of the CSV file. When creating :class:`reader` or
:class:`writer` objects, the programmer can specify a string or a subclass of :class:`writer` objects, the programmer can specify a string or a subclass of
the :class:`Dialect` class as the dialect parameter. In addition to, or instead the :class:`Dialect` class as the dialect parameter. In addition to, or instead
of, the *dialect* parameter, the programmer can also specify individual of, the *dialect* parameter, the programmer can also specify individual
@ -470,9 +470,9 @@ DictReader objects have the following public attribute:
Writer Objects Writer Objects
-------------- --------------
:class:`Writer` objects (:class:`DictWriter` instances and objects returned by :class:`writer` objects (:class:`DictWriter` instances and objects returned by
the :func:`writer` function) have the following public methods. A *row* must be the :func:`writer` function) have the following public methods. A *row* must be
an iterable of strings or numbers for :class:`Writer` objects and a dictionary an iterable of strings or numbers for :class:`writer` objects and a dictionary
mapping fieldnames to strings or numbers (by passing them through :func:`str` mapping fieldnames to strings or numbers (by passing them through :func:`str`
first) for :class:`DictWriter` objects. Note that complex numbers are written first) for :class:`DictWriter` objects. Note that complex numbers are written
out surrounded by parens. This may cause some problems for other programs which out surrounded by parens. This may cause some problems for other programs which

1
Doc/tools/.nitignore
View file

@ -27,7 +27,6 @@ Doc/library/asyncio-subprocess.rst
Doc/library/bdb.rst Doc/library/bdb.rst
Doc/library/collections.rst Doc/library/collections.rst
Doc/library/copy.rst Doc/library/copy.rst
Doc/library/csv.rst
Doc/library/ctypes.rst Doc/library/ctypes.rst
Doc/library/dbm.rst Doc/library/dbm.rst
Doc/library/decimal.rst Doc/library/decimal.rst