You-Dont-Need-JavaScript icon indicating copy to clipboard operation
You-Dont-Need-JavaScript copied to clipboard

README.MD missing word "not" in a sentence

Open julesmanson opened this issue 5 years ago • 10 comments

Please bear with me. I am new to GitHub and git. In the very first sentence of the first paragraph (just below the page title (You Don't Need JavaScript) we have the sentence (set to bold for easy identification):

Please note these demos should be considered as CSS "Proofs of Concepts". They may have serious issues from accessibility point of view (keyboard navigation, speech synthesis, etc.), or progressive enhancement/degradation/etc.

Perhaps what you meant to say was (word in bold added):

Please note these demos should NOT be considered as CSS "Proofs of Concepts". They may have serious issues from accessibility point of view (keyboard navigation, speech synthesis, etc.), or progressive enhancement/degradation/etc.

julesmanson avatar Jan 01 '19 18:01 julesmanson

But they are proofs of concepts. This repo is not a library for production use, it just shows that JS is unneeded for most of things.

And instead of creating this issue the more clean way is to create a PR. GH built in editor can be used for that.

KOLANICH avatar Jan 01 '19 18:01 KOLANICH

They are "Proofs of Concepts" and you should think twice before you write something like this in real projects.

stevemao avatar Jan 02 '19 04:01 stevemao

and you should think twice before you write something like this in real projects.

Why not? Support for lot of the features used had come into browsers long enough ago, is pretty stable and is used in production.

KOLANICH avatar Jan 02 '19 09:01 KOLANICH

Up to you. But I don't think there's anything wrong with the sentence...

stevemao avatar Jan 02 '19 10:01 stevemao

"Proof of concept" depends on context (or scope if you prefer). The context cautions users about accessibility and performance (progressive degradation/enhancement issues) with respect to browser compatibility I am assuming. If that is the case then the word NOT applies. It would suggest that because these CSS methods may not universally render these methods may not be considered "proof of concepts."

julesmanson avatar Jan 03 '19 04:01 julesmanson

This is a definitional question, in which I fear yours runs afoul of consensus usage. Independent of scope a Proof of Concept is a test, example, or implementation otherwise less featureful than an enterprise grade product, and as such may bear the deficiencies enumerated in the subsequent sentence. Insofar as this repository does not exclude projects on the basis of, e.g., accessibility issues, the blanket caveat that they might be Proofs of Concept is warranted.

jpt4 avatar Jan 03 '19 05:01 jpt4

If the goal is accessibility and performance across a wide range of devices and clients then this is NOT a

proof of concept.

julesmanson avatar Jan 03 '19 09:01 julesmanson

If the goal is accessibility and performance

They are not the goals of this repo:

They may have serious issues from accessibility point of view (keyboard navigation, speech synthesis, etc.), or progressive enhancement/degradation/etc.

KOLANICH avatar Jan 03 '19 09:01 KOLANICH

Oh gawd I give up. I was only trying to help. Regardless this is one outstanding series of repos.

julesmanson avatar Jan 03 '19 10:01 julesmanson

@julesmanson
Thanks for your attention to details! PR is welcome.

cht8687 avatar Sep 16 '19 10:09 cht8687