Skip to content

Commit 59d4ea8

Browse files
PeterDaveHelloljharb
authored andcommitted
[Docs] Clean up wording in docs and shell comments
Adjust a few spelling, grammar, and naming inconsistencies in the docs and related shell comments without changing behavior.
1 parent 6a16398 commit 59d4ea8

4 files changed

Lines changed: 6 additions & 6 deletions

File tree

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Explain the problem and include additional details to help maintainers reproduce
2323
* **Use a clear and descriptive title** for the issue to identify the problem.
2424

2525
* **Describe the exact steps which reproduce the problem** in as many details as possible. For example, start by explaining which command exactly you used in the terminal. When listing steps, **don't just say what you did, but explain how you did it**. For example, if you moved the cursor to the end of a line, explain if you used the mouse, or a keyboard shortcut or a command, and if so which one?
26-
* **Provide specific examples to demonstrate the steps**. Include links to files or Github projects, or copy/pasteable snippets, which you use in those examples. If you're providing snippets in the issue, use [Markdown code blocks](https://help.github.com/articles/markdown-basics/#multiple-lines).
26+
* **Provide specific examples to demonstrate the steps**. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples. If you're providing snippets in the issue, use [Markdown code blocks](https://help.github.com/articles/markdown-basics/#multiple-lines).
2727
* **Describe the behavior you observed after following the steps** and point out what exactly is the problem with that behavior.
2828
* **Explain which behavior you expected to see instead and why.**
2929
* **Provide as much context as possible** in order to help others verify and ultimately fix the issue. This includes giving us as many details as possible about your environment, so we can more easily confirm the problem.

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ Simple as that!
9595

9696

9797
## About
98-
nvm is a version manager for [node.js](https://nodejs.org/en/), designed to be installed per-user, and invoked per-shell. `nvm` works on any POSIX-compliant shell (sh, dash, ksh, zsh, bash), in particular on these platforms: unix, macOS, and [windows WSL](https://github.com/nvm-sh/nvm#important-notes).
98+
nvm is a version manager for [node.js](https://nodejs.org/en/), designed to be installed per-user, and invoked per-shell. `nvm` works on any POSIX-compliant shell (sh, dash, ksh, zsh, bash), in particular on these platforms: unix, macOS, and [Windows WSL](https://github.com/nvm-sh/nvm#important-notes).
9999

100100
<a id="installation-and-update"></a>
101101
<a id="install-script"></a>
@@ -279,7 +279,7 @@ which should output `nvm` if the installation was successful. Please note that `
279279

280280
If you're running a system without prepackaged binary available, which means you're going to install node or io.js from its source code, you need to make sure your system has a C++ compiler. For OS X, Xcode will work, for Debian/Ubuntu based GNU/Linux, the `build-essential` and `libssl-dev` packages work.
281281

282-
**Note:** `nvm` also supports Windows in some cases. It should work through WSL (Windows Subsystem for Linux) depending on the version of WSL. It should also work with [GitBash](https://gitforwindows.org/) (MSYS) or [Cygwin](https://cygwin.com). Otherwise, for Windows, a few alternatives exist, which are neither supported nor developed by us:
282+
**Note:** `nvm` also supports Windows in some cases. It should work through WSL (Windows Subsystem for Linux) depending on the version of WSL. It should also work with [Git Bash](https://gitforwindows.org/) (MSYS) or [Cygwin](https://cygwin.com). Otherwise, for Windows, a few alternatives exist, which are neither supported nor developed by us:
283283

284284
- [nvm-windows](https://github.com/coreybutler/nvm-windows)
285285
- [nodist](https://github.com/marcelklehr/nodist)
@@ -940,7 +940,7 @@ Alpine Linux, unlike mainstream/traditional Linux distributions, is based on [Bu
940940
941941
There is a `-s` flag for `nvm install` which requests nvm download Node source and compile it locally.
942942
943-
If installing nvm on Alpine Linux *is* still what you want or need to do, you should be able to achieve this by running the following from you Alpine Linux shell, depending on which version you are using:
943+
If installing nvm on Alpine Linux *is* still what you want or need to do, you should be able to achieve this by running the following from your Alpine Linux shell, depending on which version you are using:
944944
945945
### Alpine Linux 3.13+
946946
```sh

install.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ nvm_source() {
6767
IT IS POSSIBLE THAT SOMEONE IS DOING SOMETHING NASTY!
6868
6969
The default repository for this install is \`nvm-sh/nvm\`,
70-
but the environment variables \`\$NVM_INSTALL_GITHUB_REPO\` is
70+
but the environment variable \`\$NVM_INSTALL_GITHUB_REPO\` is
7171
currently set to \`${NVM_GITHUB_REPO}\`.
7272
7373
If this is not intentional, interrupt this installation and

nvm.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2282,7 +2282,7 @@ nvm_install_binary_extract() {
22822282
command mkdir -p "${TMPDIR}" && \
22832283
VERSION_PATH="$(nvm_version_path "${PREFIXED_VERSION}")" || return 1
22842284

2285-
# For Windows system (GitBash with MSYS, Cygwin)
2285+
# For Windows system (Git Bash with MSYS, Cygwin)
22862286
if [ "${NVM_OS}" = 'win' ]; then
22872287
VERSION_PATH="${VERSION_PATH}/bin"
22882288
command unzip -q "${TARBALL}" -d "${TMPDIR}" || return 1

0 commit comments

Comments
 (0)