gh-132813: Fix the csv documentation for quoting and escaping #133209
Conversation
quotechar and new-line characters are always quoted or escaped. escapechar is always escaped.
|
What can also be surprising is different behavior for |
|
It was. In the past, |
|
@serhiy-storchaka IIUC, |
Doc/library/csv.rst
Outdated
| A one-character string used by the writer to escape the *delimiter*, | ||
| the *quotechar*, ``'\r'``, ``'\n'`` and any of the characters in | ||
| *lineterminator* if *quoting* is set to :const:`QUOTE_NONE`, | ||
| the *quotechar* if *doublequote* is :const:`False`, |
There was a problem hiding this comment.
I do not understand this part of the sentence in the original, nor the addition below.
There was a problem hiding this comment.
How would you write it?
Different characters are escaped depending on different conditions:
- if quoting is set to :const:
QUOTE_NONE, it escapes delimiter, quotechar, etc. - if doublequote is False, it escapes quotechar.
There was a problem hiding this comment.
Perhaps:
A one-character string for escaping. If quoting is set to :const:QUOTE_NONE, it escapes delimiter, quotechar, ``'\r'``, ``'\n'`` and any of the characters in *lineterminator*. If doublequote is False, it escapes quotechar
|
When you're done making the requested changes, leave the comment: |
|
It would be nice if the docs mentioned explicitly that which says that "empty" is not allowed, whatever that might be meaning (and many people would consider |
|
This what this PR does. |
|
I have made the requested changes; please review again. |
|
Thanks for making the requested changes! @terryjreedy: please review the changes made to this pull request. |
quotechar and new-line characters are always quoted or escaped. escapechar is always escaped.
csv.writerwithQUOTE_NONEstill requires non-emtpyquotecharandescapechar#132813📚 Documentation preview 📚: https://cpython-previews--133209.org.readthedocs.build/