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.

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

Jump to bottom

docs: Correct capitalization for URL #7285

Merged
merged 1 commit into from
Mar 14, 2024
Merged

docs: Correct capitalization for URL #7285

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 9 additions & 9 deletions docs/lib/content/configuring-npm/package-json.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ your package as it's listed in `npm search`.

### homepage

The url to the project homepage.
The URL to the project homepage.

Example:

Expand All @@ -85,7 +85,7 @@ Example:

### bugs

The url to your project's issue tracker and / or the email address to which
The URL to your project's issue tracker and / or the email address to which
issues should be reported. These are helpful for people who encounter
issues with your package.

Expand All @@ -101,10 +101,10 @@ It should look like this:
```

You can specify either one or both values. If you want to provide only a
url, you can specify the value for "bugs" as a simple string instead of an
URL, you can specify the value for "bugs" as a simple string instead of an
object.

If a url is provided, it will be used by the `npm bugs` command.
If a URL is provided, it will be used by the `npm bugs` command.

### license

Expand Down Expand Up @@ -511,9 +511,9 @@ Do it like this:
}
```

The URL should be a publicly available (perhaps read-only) url that can be
The URL should be a publicly available (perhaps read-only) URL that can be
handed directly to a VCS program without any modification. It should not
be a url to an html project page that you put in your browser. It's for
be a URL to an html project page that you put in your browser. It's for
computers.

For GitHub, GitHub gist, Bitbucket, or GitLab repositories you can use the
Expand Down Expand Up @@ -636,7 +636,7 @@ install time.

#### Git URLs as Dependencies

Git urls are of the form:
Git URLs are of the form:

```bash
<protocol>://[<user>[:<password>]@]<hostname>[:<port>][:][/]<path>[#<commit-ish> | #semver:<semver>]
Expand Down Expand Up @@ -683,7 +683,7 @@ will be rebuilt for every installation.

#### GitHub URLs

As of version 1.1.65, you can refer to GitHub urls as just "foo":
As of version 1.1.65, you can refer to GitHub URLs as just "foo":
"user/foo-project". Just as with git URLs, a `commit-ish` suffix can be
included. For example:

Expand Down Expand Up @@ -889,7 +889,7 @@ none.
If a dependency can be used, but you would like npm to proceed if it cannot
be found or fails to install, then you may put it in the
`optionalDependencies` object. This is a map of package name to version or
url, just like the `dependencies` object. The difference is that build
URL, just like the `dependencies` object. The difference is that build
failures do not cause installation to fail. Running `npm install
--omit=optional` will prevent these dependencies from being installed.

Expand Down
Loading