From 39af319cb00364799c3345d7004f5e3fe9e14f5d Mon Sep 17 00:00:00 2001 From: Helio Frota <00hf11@gmail.com> Date: Tue, 17 Nov 2020 14:38:58 -0300 Subject: [PATCH] docs: fix some typos (#1807) --- docs/api.md | 6 +++--- docs/browser.md | 2 +- docs/bundling.md | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/api.md b/docs/api.md index 7cb20eda6..6b24ebc2e 100644 --- a/docs/api.md +++ b/docs/api.md @@ -807,7 +807,7 @@ error message when this promise rejects .exit(code, err) --------- Manually indicate that the program should exit, and provide context about why we -wanted to exit. Follows the behaviour set by `.exitProcess()`. +wanted to exit. Follows the behavior set by `.exitProcess()`. .fail(fn) --------- @@ -816,7 +816,7 @@ Method to execute when a failure occurs, rather than printing the failure messag `fn` is called with the failure message that would have been printed, the `Error` instance originally thrown and yargs state when the failure -occured. +occurred. ```js var argv = require('yargs/yargs')(process.argv.slice(2)) @@ -1308,7 +1308,7 @@ for details of this object For additional configuration options, see [yargs-parser's configuration](https://github.com/yargs/yargs-parser#configuration). -_Note: configuraton should be top level keys on the `obj` passed to `parserConfiguration`, not populated under the configuration key, as in `yargs-parser`._ +_Note: configuration should be top level keys on the `obj` passed to `parserConfiguration`, not populated under the configuration key, as in `yargs-parser`._ .pkgConf(key, [cwd]) diff --git a/docs/browser.md b/docs/browser.md index f8f6eb053..1e25d7073 100644 --- a/docs/browser.md +++ b/docs/browser.md @@ -1,6 +1,6 @@ # Running yargs in the browser -Newer versions of yargs have a `./browser.mjs` entrypoint, which can be used +Newer versions of yargs have a `./browser.mjs` entry point, which can be used through a CDN like [unpkg.com](https://unpkg.com/) to load yargs directly in the browser: diff --git a/docs/bundling.md b/docs/bundling.md index 9a035d1ec..e3f5210c1 100644 --- a/docs/bundling.md +++ b/docs/bundling.md @@ -10,7 +10,7 @@ Newer releases of yargs can run directly in modern browsers, take a look at ## ncc -If you are targetting Node.js with your bundle, we recommend using +If you are targeting Node.js with your bundle, we recommend using [`@vercel/ncc`](https://www.npmjs.com/package/@vercel/ncc). Given a CommonJS file, **index.js**: