-
-
Notifications
You must be signed in to change notification settings - Fork 34k
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
gh-135243: improve CSV docs #135246
Conversation
picnixz
left a comment
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.
The second paragraph doesn't need updates IMO.
picnixz
left a comment
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 am still not convinced by these changes. I agree that the paragraph can be improved, but I don't think the entire reformulation is better. Some parts of it are but not all.
Also, I would appreciate if we don't change the line wrap when possible because it makes diffs much harder to read.
Personally, I use "users" instead of "Programmers" because it's shorter and more common in our docs nowadays.
Doc/library/csv.rst
Outdated
| of text data separated by a comma delimiter. The standards for CSV data are | ||
| defined in :rfc:`4180`. |
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.
There is only one standard. What the RFC defines are the specifications of CSV which is not restricted to CSV data. CSV data is what is being processed; CSV format how the data is presented before being processed and this is what the RFC defines.
|
A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated. Once you have made the requested changes, please leave a comment on this pull request containing the phrase |
Address review comments from picnixz
|
I have made the requested changes; please review again |
|
Thanks for making the requested changes! @picnixz: please review the changes made to this pull request. |
|
Thanks, but I think this change is not a substantial improvement, and it in fact makes some things worse (e.g. removing commentary in the first two sentences makes "the lack of a well defined standard" seem contradictory) |
Updates for GH-135243 to cpython/Doc/library/csv.rst file for these issues:
📚 Documentation preview 📚: https://cpython-previews--135246.org.readthedocs.build/