docs: clarify DictReader's treatment of the first data row. #118549
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
shenanigansd
approved these changes
May 3, 2024
rfdzan
reviewed
May 3, 2024
Doc/library/csv.rst
Outdated
| @@ -156,8 +156,10 @@ The :mod:`csv` module defines the following classes: | |||
|
|
|||
| The *fieldnames* parameter is a :term:`sequence`. If *fieldnames* is | |||
| omitted, the values in the first row of file *f* will be used as the | |||
| fieldnames. Regardless of how the fieldnames are determined, the | |||
| dictionary preserves their original ordering. | |||
| fieldnames and the first row will not produce a dict in the result. If | |||
There was a problem hiding this comment.
Since the first row will be used as the fieldnames and be omitted, how about writing this line as simply:
"...fieldnames and therefore be omitted. If..."
rfdzan
approved these changes
May 3, 2024
JelleZijlstra
approved these changes
May 3, 2024
|
Thanks @nedbat for the PR, and @JelleZijlstra for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12. |
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
May 3, 2024
…nGH-118549) (cherry picked from commit 9d67b72) Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
|
GH-118555 is a backport of this pull request to the 3.12 branch. |
JelleZijlstra
pushed a commit
that referenced
this pull request
May 3, 2024
…GH-118549) (#118555) (cherry picked from commit 9d67b72) Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
SonicField
pushed a commit
to SonicField/cpython
that referenced
this pull request
May 8, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
A clarification based on a discussion in the Python discord.
📚 Documentation preview 📚: https://cpython-previews--118549.org.readthedocs.build/