Add another note about command modules

documentationjs · Dec 6, 2015 · b609664 · b609664
1 parent 0022934
commit b609664
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 3 deletions.
diff --git a/lib/commands/build.js b/lib/commands/build.js
@@ -51,8 +51,7 @@ function build(documentation, parsedArgs, callback) {
     hljs: options.hljs || {}
   };
 
-  var generator = documentation.bind(null,
-    inputs, options, onDocumented);
+  var generator = documentation.bind(null, inputs, options, onDocumented);
 
   function onDocumented(err, comments) {
     if (err) {

diff --git a/lib/commands/index.js b/lib/commands/index.js
@@ -1,8 +1,12 @@
 /*
  * Maps command name to a command plugin module.  Each command plugin module
- * should export a function that takes (documentation, parsedArgs), where
+ * must export a function that takes (documentation, parsedArgs), where
  * documentation is just the main module (index.js), and parsedArgs is
  * { inputs, options, command, commandOptions }
+ *
+ * Command modules should also export a `description`, which will be used in
+ * the main CLI help, and optionally a `parseArgs(yargs, parentArgv)` function
+ * to parse additional arguments.
  */
 
 module.exports = {