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

Need change in the read me file #24872

Closed
tibinthomas opened this issue Dec 6, 2018 · 13 comments
Closed

Need change in the read me file #24872

tibinthomas opened this issue Dec 6, 2018 · 13 comments
Labels
doc Issues and PRs related to the documentations. good first issue Issues that are suitable for first-time contributors.

Comments

@tibinthomas
Copy link

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

@bnoordhuis bnoordhuis added the doc Issues and PRs related to the documentations. label Dec 6, 2018
@bnoordhuis
Copy link
Member

You're proposing s/runtime/run-time/? Note that our documentation overwhelmingly favors "runtime", no dash.

@ZYSzys
Copy link
Member

ZYSzys commented Dec 6, 2018

IMHO, the sentence at present is appropriate enough, I don't think we need to change that.

@addaleax
Copy link
Member

addaleax commented Dec 6, 2018

The suggestion is also adding that is, which sounds like it might indeed make things a bit easier to understand for non-native speakers?

@devsnek
Copy link
Member

devsnek commented Dec 6, 2018

fwiw: my code evaluates at run-time in the node.js runtime

@tibinthomas
Copy link
Author

tibinthomas commented Dec 7, 2018

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.

@Anithabalu
Copy link

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

@Trott
Copy link
Member

Trott commented Dec 8, 2018

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

@ZYSzys
Copy link
Member

ZYSzys commented Dec 20, 2018

So as a result, we should just cut down the later sentence built on Chrome's V8 JavaScript engine right ?
And if we came to an agreement, I'm willing to make the change on both the README in this repo and the website.

@stevemao
Copy link
Contributor

built on Chrome's V8 JavaScript engine is an implementation detail IMO.

@gireeshpunathil
Copy link
Member

what is the take on this?

@Trott
Copy link
Member

Trott commented Jan 3, 2020

The English-language Wikipedia article for Node.js has this as the first sentence at this time:

Node.js is an open-source, cross-platform, JavaScript runtime environment that executes JavaScript code outside of a browser.

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:

Node.js is an open-source, cross-platform, JavaScript runtime environment. It executes JavaScript code outside of a browser.

@gireeshpunathil gireeshpunathil added the good first issue Issues that are suitable for first-time contributors. label Jan 4, 2020
@zlatanvasovic
Copy link

What is wrong with simply

Node.js is an open-source, cross-platform runtime environment that executes JavaScript code outside of a browser.

@Trott
Copy link
Member

Trott commented Jan 4, 2020

What is wrong with simply

Node.js is an open-source, cross-platform runtime environment that executes JavaScript code outside of a browser.

I find the two-sentence construction easier to read, but that's just my opinion. The above would be fine too.

carterbancroft added a commit to carterbancroft/node that referenced this issue Jan 9, 2020
@Trott Trott closed this as completed in 6d44308 Jan 11, 2020
MylesBorins pushed a commit that referenced this issue Jan 16, 2020
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]>
codebytere pushed a commit that referenced this issue Mar 14, 2020
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]>
codebytere pushed a commit that referenced this issue Mar 17, 2020
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]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations. good first issue Issues that are suitable for first-time contributors.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

10 participants