-
Notifications
You must be signed in to change notification settings - Fork 29.1k
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
doc: change e.g to for example #18397
Changes from all commits
5021d43
bf93260
15e8963
fb24a5d
bcef244
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -62,7 +62,7 @@ note1 - The gcc4.8-libs package needs to be installed, because node | |
|
||
*Note*: On Windows, running Node.js in windows terminal emulators like `mintty` | ||
requires the usage of [winpty](https://github.com/rprichard/winpty) for | ||
Node's tty channels to work correctly (e.g. `winpty node.exe script.js`). | ||
Node's tty channels to work correctly (for example: `winpty node.exe script.js`). | ||
In "Git bash" if you call the node shell alias (`node` without the `.exe` | ||
extension), `winpty` is used automatically. | ||
|
||
|
@@ -251,7 +251,7 @@ To test if Node.js was built correctly: | |
> Release\node -e "console.log('Hello from Node.js', process.version)" | ||
``` | ||
|
||
### Android/Android-based devices (e.g. Firefox OS) | ||
### Android/Android-based devices (for example: Firefox OS) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This would probably be better/clearer as |
||
|
||
Although these instructions for building on Android are provided, please note | ||
that Android is not an officially supported platform at this time. Patches to | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -243,7 +243,7 @@ Examples of breaking changes include: | |
* altering expected timing of an event | ||
* changing the side effects of using a particular API | ||
|
||
Purely additive changes (e.g. adding new events to `EventEmitter` | ||
Purely additive changes (for example: adding new events to `EventEmitter` | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is a place where |
||
implementations, adding new arguments to a method in a way that allows | ||
existing code to continue working without modification, or adding new | ||
properties to an options argument) are semver-minor changes. | ||
|
@@ -267,7 +267,7 @@ Such changes *must* be handled as semver-major changes but MAY be landed | |
without a [Deprecation cycle](#deprecation-cycle). | ||
|
||
Note that errors thrown, along with behaviors and APIs implemented by | ||
dependencies of Node.js (e.g. those originating from V8) are generally not | ||
dependencies of Node.js (for example: those originating from V8) are generally not | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
under the control of Node.js and therefore *are not directly subject to this | ||
policy*. However, care should still be taken when landing updates to | ||
dependencies when it is known or expected that breaking changes to error | ||
|
@@ -308,7 +308,7 @@ Specifically: | |
|
||
* Breaking changes should *never* land in Current or LTS except when: | ||
* Resolving critical security issues. | ||
* Fixing a critical bug (e.g. fixing a memory leak) requires a breaking | ||
* Fixing a critical bug (for example: fixing a memory leak) requires a breaking | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. comma instead of colon |
||
change. | ||
* There is TSC consensus that the change is required. | ||
* If a breaking commit does accidentally land in a Current or LTS branch, an | ||
|
@@ -623,7 +623,7 @@ error: failed to push some refs to 'https://github.com/nodejs/node' | |
hint: Updates were rejected because the remote contains work that you do | ||
hint: not have locally. This is usually caused by another repository pushing | ||
hint: to the same ref. You may want to first integrate the remote changes | ||
hint: (e.g. 'git pull ...') before pushing again. | ||
hint: (for example: 'git pull ...') before pushing again. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is output from a command. It should not be changed. |
||
hint: See the 'Note about fast-forwards' in 'git push --help' for details. | ||
``` | ||
|
||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nit: while in here, maybe
Node's
->Node.js's
or even just removeNode's
altogether.