gh-135243: improve CSV docs #135246
Open
gh-135243: improve CSV docs #135246
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
|
All commit authors signed the Contributor License Agreement. |
picnixz
reviewed
Jun 8, 2025
| 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 |
There was a problem hiding this comment.
I don't think we need this change.
There was a problem hiding this comment.
Reasoning for the changes are:
- "it" is ambiguous but refers to the module.
- Those two statements the programmer is saying (to themself?) is a scenario. By adding "for example" (which is typical in technical documentation), we highlight that it is one thing someone can do but not the only thing.
- Very very minor: there is a technical difference between "allows" and "enables".
Doc/library/csv.rst
Outdated
| 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.
"that is" is added to improve readability for ESL users (Global English guidelines) and localization.
Doc/library/csv.rst
Outdated
| 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 | ||
| can also describe CSV formats that are used by other applications or define custom CSV |
There was a problem hiding this comment.
Understood is the correct term here. Because we use the term "dialect" for that.
There was a problem hiding this comment.
pushed new update for this issue
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.
Updates for GH-135243 to cpython/Doc/library/csv.rst file for these issues:
📚 Documentation preview 📚: https://cpython-previews--135246.org.readthedocs.build/