doc: update docs to reflect new parserConfiguration method (#1280)

yargs · Jan 30, 2019 · 61f1b25 · 61f1b25
1 parent 3c6869a
commit 61f1b25
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 6 deletions.
diff --git a/docs/advanced.md b/docs/advanced.md
@@ -431,19 +431,18 @@ possible to build plugin architectures similar to [Babel's presets](https://babe
 ## Customizing Yargs' Parser
 
 Not everyone always agrees on how `process.argv` should be interpreted;
-using the `yargs` stanza in your `package.json` you can turn on and off
-some of yargs' parsing features:
+using the [`parserConfiguration()`](/docs/api.md#parserConfiguration) method you can turn on and off some of yargs' parsing features:
 
-```json
-{
+```js
+yargs.parserConfiguration({
   "yargs": {
     "short-option-groups": true,
     "camel-case-expansion": true,
     "dot-notation": true,
     "parse-numbers": true,
     "boolean-negation": true
   }
-}
+})
 ```
 
 See the [yargs-parser](https://github.com/yargs/yargs-parser#configuration) module

diff --git a/docs/api.md b/docs/api.md
@@ -1151,7 +1151,8 @@ for details of this object
 
 <a name="parserConfiguration"></a>.parserConfiguration(obj)
 ------------
-`parserConfiguration()` allows you to configure yargs-parser, see [yargs-parser's configuration](https://github.com/yargs/yargs-parser#configuration).
+`parserConfiguration()` allows you to configure yargs. See [yargs-parser's configuration](https://github.com/yargs/yargs-parser#configuration) for
+settings specific to `yargs-parser`.
 
 <a name="pkg-conf"></a>
 .pkgConf(key, [cwd])