Skip to content

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
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Conversation

weflower
Copy link

@weflower weflower commented Jun 8, 2025

Updates for GH-135243 to cpython/Doc/library/csv.rst file for these issues:

  • Reworded the introduction to remove "so called CVS"
  • Edited the first and second paragraphs to improve readability and information

📚 Documentation preview 📚: https://cpython-previews--135246.org.readthedocs.build/

@python-cla-bot
Copy link

python-cla-bot bot commented Jun 8, 2025

All commit authors signed the Contributor License Agreement.

CLA signed

@picnixz picnixz changed the title pythonGH-135243 docs: update CSV page to improve readability and language gh-135243: improve CSV docs Jun 8, 2025
Copy link
Member

@picnixz picnixz left a 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.

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
Copy link
Member

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.

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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nor this one

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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Understood is the correct term here. Because we use the term "dialect" for that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
awaiting review docs Documentation in the Doc dir skip news
Projects
Status: Todo
Development

Successfully merging this pull request may close these issues.

2 participants
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy