doc: clarify parserConfiguration object structure (#1309)

yargs · Mar 31, 2019 · 9f2468e · 9f2468e
1 parent e7f2937
commit 9f2468e
Showing 1 changed file with 2 additions and 0 deletions.
diff --git 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`.
+
 <a name="pkg-conf"></a>
 .pkgConf(key, [cwd])
 ------------