mirror of
https://github.com/nvm-sh/nvm.git
synced 2026-04-03 11:34:50 +08:00
[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.
This commit is contained in:
committed by
Jordan Harband
parent
6a16398269
commit
59d4ea8f3e
@@ -23,7 +23,7 @@ Explain the problem and include additional details to help maintainers reproduce
|
|||||||
* **Use a clear and descriptive title** for the issue to identify the problem.
|
* **Use a clear and descriptive title** for the issue to identify the problem.
|
||||||
|
|
||||||
* **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?
|
* **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?
|
||||||
* **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).
|
* **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).
|
||||||
* **Describe the behavior you observed after following the steps** and point out what exactly is the problem with that behavior.
|
* **Describe the behavior you observed after following the steps** and point out what exactly is the problem with that behavior.
|
||||||
* **Explain which behavior you expected to see instead and why.**
|
* **Explain which behavior you expected to see instead and why.**
|
||||||
* **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.
|
* **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.
|
||||||
|
|||||||
@@ -95,7 +95,7 @@ Simple as that!
|
|||||||
|
|
||||||
|
|
||||||
## About
|
## About
|
||||||
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).
|
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).
|
||||||
|
|
||||||
<a id="installation-and-update"></a>
|
<a id="installation-and-update"></a>
|
||||||
<a id="install-script"></a>
|
<a id="install-script"></a>
|
||||||
@@ -940,7 +940,7 @@ Alpine Linux, unlike mainstream/traditional Linux distributions, is based on [Bu
|
|||||||
|
|
||||||
There is a `-s` flag for `nvm install` which requests nvm download Node source and compile it locally.
|
There is a `-s` flag for `nvm install` which requests nvm download Node source and compile it locally.
|
||||||
|
|
||||||
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:
|
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:
|
||||||
|
|
||||||
### Alpine Linux 3.13+
|
### Alpine Linux 3.13+
|
||||||
```sh
|
```sh
|
||||||
|
|||||||
@@ -67,7 +67,7 @@ nvm_source() {
|
|||||||
IT IS POSSIBLE THAT SOMEONE IS DOING SOMETHING NASTY!
|
IT IS POSSIBLE THAT SOMEONE IS DOING SOMETHING NASTY!
|
||||||
|
|
||||||
The default repository for this install is \`nvm-sh/nvm\`,
|
The default repository for this install is \`nvm-sh/nvm\`,
|
||||||
but the environment variables \`\$NVM_INSTALL_GITHUB_REPO\` is
|
but the environment variable \`\$NVM_INSTALL_GITHUB_REPO\` is
|
||||||
currently set to \`${NVM_GITHUB_REPO}\`.
|
currently set to \`${NVM_GITHUB_REPO}\`.
|
||||||
|
|
||||||
If this is not intentional, interrupt this installation and
|
If this is not intentional, interrupt this installation and
|
||||||
|
|||||||
Reference in New Issue
Block a user