-
Notifications
You must be signed in to change notification settings - Fork 365
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
Remove typographic quotes #324
Comments
Which command line tools have problems handling these quotes? I'm assuming the only tools you would be using to process the README would be markdown parsers and text editors. Markdown parsers should have no problem, but maybe some editors do? Can you provide information about the editors and other tools (?) that this causes problems with? I fail to see the motivation behind this, especially considering that this isn't even an edge case or anything, it's just basic UTF-8, which should absolutely be the default in 2019 and I would consider anything that can't handle it to be broken. Maybe raise an issue about improper UTF-8 handling in the issue tracker for those tools? |
@CryZe grep, sed, ... Editors need to have fonts installed which can render this and then even some do have problems rendering multi-byte characters which is the reason why using Unicode in Markdown without any compelling reason is generally frowned upon. Also there's the issue of equivalency classes in Unicode; there're tons of different quotes and who's going to ensure they're applied in a consistent manner. The motivation for this issue is accessibility. The quotes should not have been changed in the first place but the nit changing them back has been dismissed because "we can always change that back later" which is what this issue is about. |
These are going to be copy pasted. I don't see how you are going to accidentally introduce a different one. And even if you did, I don't see what issue this even causes. Yes you might not find all of them anymore when grepping, but why would you ever even grep for these in the first place? Which brings us to grep. It works just fine for me:
I don't find the fonts argument to be compelling either. The fonts for it should be installed on pretty much every system. I don't think any normal operating system is missing these. And if you are using a super random rare operating system, you probably have other problems than the quotation marks of the readme not rendering correctly. Like that's what I not get. You act as if these quotation marks are going to cause massive issues when in reality the issues that could potentially happen are so rare and have so little impact. |
They could cause problems and there's no reason for them to actually be there. It's not up to me to demonstrate that they will cause problems. My nit about this needless change has been dismissed to not hold up the release and under the premise that this will be rectified later. I'm just following up on this and actually I'm slightly confused that I have to do so because where I come from, if you knowingly introduce or accept (technical) debt the onus is on you make sure it's rectified. |
Sure, if you copy and paste the glyphs out of the document you can use any unicode aware tools to work with them. You're very much missing the point... |
What kind of editors cannot display Unicode characters? I'd switch editors or file a bug report for that editor in that case.
So should we also stop writing new code and keep using ancient technology instead since new one could cause problems? I wonder why no-one has filed an issue for the “✓” character in the ReadMe yet.
The point being? |
It's best practice to stick to ASCII (i.e. characters which you can find on a regular keyboard) as much as possible to allow people to seamlessly work with those documents with regular tools. If a markdown renderer wants to render them as English textbook quotes for presentation, that's perfectly okay but they shouldn't be in the source files.
Seriously? |
Clearly there is no canonical best practice on this as is apparent by looking at this discussion. |
So all best practises are out of the window as soon as a single person disagrees with them (for whatever reason)? That's interesting... |
Well, it seems best practices for typesetting English text are out of the window because you disagree. There is a place for compatibility best practices, a ReadMe file written in Markdown which the majority of people will only ever view rendered as HTML on GitHub isn't it. |
Closing this issue as stale. However, if someone wants to adjust these tokens, open a PR! Reading through the thread, I feel there was some heated and opinionated discussion and I'd like to remind everyone of the CoC
I'm sure no one meant any harm, but remember that text is an inferiour medium when executed with emotion, and that words can hurt, even if not meant to be hurtful. <3 |
As per #302 (comment) someone should fix the use of typographic quotes in the markdown files to ensure compatibility with command line tools and editors.
CC @Dylan-DPC
The text was updated successfully, but these errors were encountered: