From 9f2468e9fe948c67b7891fd48b8eafbc0c8591b6 Mon Sep 17 00:00:00 2001 From: "Benjamin E. Coe" Date: Sun, 31 Mar 2019 11:40:45 -0700 Subject: [PATCH] doc: clarify parserConfiguration object structure (#1309) --- docs/api.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/api.md b/docs/api.md index 877b06aec..12f3837dc 100644 --- a/docs/api.md +++ b/docs/api.md @@ -1190,6 +1190,8 @@ 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`. + .pkgConf(key, [cwd]) ------------