Skip to content
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

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

Closed
Aritra8438 opened this issue Mar 27, 2023 · 2 comments
Closed

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

Aritra8438 opened this issue Mar 27, 2023 · 2 comments

Comments

@Aritra8438
Copy link

Aritra8438 commented Mar 27, 2023

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."

@Aritra8438 Aritra8438 changed the title A Possible Typo in the [Readthedocs](https://readthedocs.org/projects/clevercsv/downloads/pdf/stable/) docs of Clevercsv package. A Possible Typo in the Readthedocs docs of Clevercsv package. Mar 27, 2023
@GjjvdBurg
Copy link
Collaborator

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

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants