-
Notifications
You must be signed in to change notification settings - Fork 30k
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
Need change in the read me file #24872
Comments
You're proposing s/runtime/run-time/? Note that our documentation overwhelmingly favors "runtime", no dash. |
IMHO, the sentence at present is appropriate enough, I don't think we need to change that. |
The suggestion is also adding |
fwiw: my code evaluates at run-time in the node.js runtime |
As a non-native speaker, it took me a while to really understand what the definition of Node really meant.. I think it is very important to give a definition that can also be understood by a non native speaker. |
I too got confused while reading it for the first time, it sounded weired. Definitely, adding a definition to it will help many people to understand it quickly |
Nothing whatsoever against V8, but I question whether it is sufficiently relevant to the average user such that it warrants mention in the very first paragraph. I'd be fine with: Node.js is a JavaScript runtime. For more information on using Node.js, see the
[Node.js Website][]. Stuff about V8, libuv, and whatever else can be delayed until later in the doc or in material linked from the doc. By the way, the same "built on" stuff appears at the top of the current website, which may be where many more people read/see it than in the README in this repo. @nodejs/website |
So as a result, we should just cut down the later sentence |
|
what is the take on this? |
The English-language Wikipedia article for Node.js has this as the first sentence at this time:
The use of JavaScript twice in the sentence is awkward, but I do wonder if that contains more useful and straightforward information than our current lead sentence in the README. Maybe we could modify it to be two sentences:
|
What is wrong with simply
|
I find the two-sentence construction easier to read, but that's just my opinion. The above would be fine too. |
Fixes: #24872 PR-URL: #31266 Reviewed-By: David Carlier <[email protected]> Reviewed-By: Gireesh Punathil <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: Rich Trott <[email protected]>
Fixes: #24872 PR-URL: #31266 Reviewed-By: David Carlier <[email protected]> Reviewed-By: Gireesh Punathil <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: Rich Trott <[email protected]>
Fixes: #24872 PR-URL: #31266 Reviewed-By: David Carlier <[email protected]> Reviewed-By: Gireesh Punathil <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: Rich Trott <[email protected]>
Could we change the sentence Node.js is a JavaScript runtime built on Chrome's V8 JavaScript engine. to Node.js is a JavaScript run-time that is built on Chrome's V8 JavaScript engine.?
The text was updated successfully, but these errors were encountered: