Skip to content

doc: change e.g to for example #18397

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.

Sign up for GitHub

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

Closed
sreepurnajasti wants to merge 5 commits into from
Closed

doc: change e.g to for example #18397

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
5021d43
doc: change e.g. to for example
sreepurnajasti Jan 26, 2018
bf93260
doc: change e.g to for example in api docs
sreepurnajasti Jan 26, 2018
15e8963
doc: change e.g to for example in docs
sreepurnajasti Jan 26, 2018
fb24a5d
doc: change e.g to for example in guides doc
sreepurnajasti Jan 26, 2018
bcef244
doc: minor changes in docs
sreepurnajasti Jan 29, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
doc: change e.g to for example in docs
  • Loading branch information
@sreepurnajasti
sreepurnajasti committed Jan 26, 2018
commit 15e8963f3c26ed085104ae44eb886162da199106
2 changes: 1 addition & 1 deletion doc/STYLE_GUIDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
* Documentation is written in markdown files with names formatted as
`lowercase-with-dashes.md`.
* Underscores in filenames are allowed only when they are present in the
topic the document will describe (e.g. `child_process`).
topic the document will describe (for example: `child_process`).
* Some files, such as top-level markdown files, are exceptions.
* Documents should be word-wrapped at 80 characters.
* The formatting described in `.editorconfig` is preferred.
Expand Down
10 changes: 5 additions & 5 deletions doc/releases.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,10 +126,10 @@ be produced with a version string that does not have a trailing pre-release tag:
This macro is used to signal an ABI version for native addons. It currently has
two common uses in the community:

- Determining what API to work against for compiling native addons, e.g.
- Determining what API to work against for compiling native addons, for example:
[NAN](https://github.com/nodejs/nan) uses it to form a compatibility-layer for
much of what it wraps.
- Determining the ABI for downloading pre-built binaries of native addons, e.g.
- Determining the ABI for downloading pre-built binaries of native addons, for example:
[node-pre-gyp](https://github.com/mapbox/node-pre-gyp) uses this value as
exposed via `process.versions.modules` to help determine the appropriate
binary to download at install-time.
Expand Down Expand Up @@ -167,7 +167,7 @@ $ changelog-maker --group --start-ref v2.3.1
There is a separate `CHANGELOG_*.md` file for each major Node.js release line.
These are located in the `doc/changelogs/` directory. Once the formatted list of
changes is collected, it must be added to the top of the relevant changelog file
in the release branch (e.g. a release for Node.js v4 would be added to the
in the release branch (for example: a release for Node.js v4 would be added to the
`/doc/changelogs/CHANGELOG_V4.md`).

**Please do *not* add the changelog entries to the root `CHANGELOG.md` file.**
Expand Down Expand Up @@ -221,7 +221,7 @@ doc/api/*.md`.
If this release includes any new deprecations it is necessary to ensure that
those are assigned a proper static deprecation code. These are listed in the
docs (see `doc/api/deprecations.md`) and in the source as `DEP00XX`. The code
must be assigned a number (e.g. `DEP0012`). Note that this assignment should
must be assigned a number (for example: `DEP0012`). Note that this assignment should
occur when the PR is landed, but a check will be made when the release built is
run.

Expand Down Expand Up @@ -390,7 +390,7 @@ This sets up the branch so that nightly builds are produced with the next
version number _and_ a pre-release tag.

Merge your release proposal branch into the stable branch that you are releasing
from (e.g. `v8.x`), and rebase the corresponding staging branch (`v8.x-staging`)
from (for example: `v8.x`), and rebase the corresponding staging branch (`v8.x-staging`)
on top of that.

Cherry-pick the release commit to `master`. After cherry-picking, edit
Expand Down