Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[3.12] gh-101100: Fix references in csv docs (GH-114658) #114771

Merged
merged 2 commits into from
Jan 31, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions Doc/library/csv.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
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*
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
Expand Down Expand Up @@ -197,10 +197,10 @@ The :mod:`csv` module defines the following classes:
Create an object which operates like a regular writer but maps dictionaries
onto 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 file
dictionary passed to the :meth:`~csvwriter.writerow` method are written to file
*f*. The optional *restval* parameter specifies the value to be
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
take.
If it is set to ``'raise'``, the default value, a :exc:`ValueError`
Expand Down Expand Up @@ -374,8 +374,8 @@ Dialects and Formatting Parameters

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
subclass of the :class:`Dialect` class having a set of specific methods and a
single :meth:`validate` method. When creating :class:`reader` or
subclass of the :class:`Dialect` class containing various attributes
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
the :class:`Dialect` class as the dialect parameter. In addition to, or instead
of, the *dialect* parameter, the programmer can also specify individual
Expand Down Expand Up @@ -492,9 +492,9 @@ DictReader objects have the following public attribute:
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
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`
first) for :class:`DictWriter` objects. Note that complex numbers are written
out surrounded by parens. This may cause some problems for other programs which
Expand Down
1 change: 0 additions & 1 deletion Doc/tools/.nitignore
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,6 @@ Doc/library/cgi.rst
Doc/library/chunk.rst
Doc/library/collections.rst
Doc/library/copy.rst
Doc/library/csv.rst
Doc/library/dbm.rst
Doc/library/decimal.rst
Doc/library/email.charset.rst
Expand Down
Loading