-
-
Notifications
You must be signed in to change notification settings - Fork 32.2k
gh-135243: improve CSV docs #135246
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
Open
weflower
wants to merge
5
commits into
python:main
Choose a base branch
from
weflower:pythonGH-135243
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
gh-135243: improve CSV docs #135246
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
fad74c8
docs: update CSV page to improve readability and language (pythonGH-1…
weflower 89105b6
doc: remove trailing space
weflower 3d93347
Merge branch 'main' into pythonGH-135243
weflower 16f6d47
GH-135243: change use to understand
weflower 97bd0eb
Merge branch 'main' into pythonGH-135243
weflower File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -14,23 +14,25 @@ | |
|
||
-------------- | ||
|
||
The so-called CSV (Comma Separated Values) format is the most common import and | ||
export format for spreadsheets and databases. CSV format was used for many | ||
years prior to attempts to describe the format in a standardized way in | ||
:rfc:`4180`. The lack of a well-defined standard means that subtle differences | ||
often exist in the data produced and consumed by different applications. These | ||
differences can make it annoying to process CSV files from multiple sources. | ||
Still, while the delimiters and quoting characters vary, the overall format is | ||
similar enough that it is possible to write a single module which can | ||
efficiently manipulate such data, hiding the details of reading and writing the | ||
data from the programmer. | ||
The Comma Separated Values (CSV) format is the most common import and | ||
export format for spreadsheets and databases. The basic format is columns | ||
of text data separated by a comma delimiter. The standards for CSV data are | ||
defined in :rfc:`4180`. | ||
|
||
The CSV format was used for many years before the standards were defined, and | ||
adherence to the standards is inconsistent. As a result, there can be variations | ||
in the delimiters and quoting characters in the CSV data that is produced and | ||
consumed by different applications. These differences can make it troublesome to | ||
process CSV files from multiple sources. However, the basic format is standard enough | ||
that a single module can efficiently manipulate this data and enable the programmer to | ||
read and write files without having to account for inconsistencies. | ||
|
||
The :mod:`csv` module implements classes to read and write tabular data in CSV | ||
format. It allows programmers to say, "write this data in the format preferred | ||
by Excel," or "read data from this file which was generated by Excel," without | ||
knowing the precise details of the CSV format used by Excel. Programmers can | ||
also describe the CSV formats understood by other applications or define their | ||
own special-purpose CSV formats. | ||
format. For example, the module enables programmers to say, "write this data in the | ||
format preferred by Excel," or "read data from this file which was generated by Excel," | ||
without knowing the precise details of the CSV format that is used by Excel. Programmers | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Nor this one There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. "that is" is added to improve readability for ESL users (Global English guidelines) and localization. |
||
can also describe CSV formats that are used by other applications or define custom CSV | ||
weflower marked this conversation as resolved.
Show resolved
Hide resolved
|
||
formats for specific use cases. | ||
|
||
The :mod:`csv` module's :class:`reader` and :class:`writer` objects read and | ||
write sequences. Programmers can also read and write data in dictionary form | ||
|
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think we need this change.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Reasoning for the changes are: