alan-turing-institute / CleverCSV

CleverCSV is a Python package for handling messy CSV files. It provides a drop-in replacement for the builtin CSV module with improved dialect detection, and comes with a handy command line application for working with CSV files.
https://clevercsv.readthedocs.io
MIT License
1.24k stars 70 forks source link

A Possible Typo in the Readthedocs docs of Clevercsv package. #91

Closed Aritra8438 closed 1 year ago

Aritra8438 commented 1 year ago

In the description of clevercsv.escape module,

Potential Escape Character is defined as A character is considered a potential escape character if it is in the “Punctuation, Other” Unicode category and in the list of blocked characters.

Block Char is defined as Characters that are in the Punctuation Other category but that should not be considered as escape character.

This two definitions are mutually contradictory, I think the definition of Potential Escape Character would be, "A character is considered a potential escape character if it is in the “Punctuation, Other” Unicode category and not in the list of blocked characters."

GjjvdBurg commented 1 year ago

Thanks for reporting this issue @Aritra8438, the correct text should be:

A character is considered a potential escape character if it is in the "Punctuation, Other" Unicode category and not in the list of blocked characters.

I'll update the documentation accordingly.

Aritra8438 commented 1 year ago

Hi @GjjvdBurg, somehow I forgot to include No in the modified definition. Thank you. I am modifying the issue accordingly.