docs

examples/confirm

@@ -6,9 +6,6 @@
 
 var program = require('../');
 
-program
-  .parse(process.argv);
-
 program.confirm('continue? ', function(ok){
   console.log(' got %j', ok);
   process.stdin.destroy();

lib/commander.js

@@ -671,6 +671,22 @@ Command.prototype.promptMultiLine = function(str, fn){
 /**
  * Prompt `str` and callback `fn(val)`
  *
+ * Commander supports single-line and multi-line prompts.
+ * To issue a single-line prompt simply add white-space
+ * to the end of `str`, something like "name: ", whereas
+ * for a multi-line prompt omit this "description:".
+ *
+ *
+ * Examples:
+ *
+ *       program.prompt('Username: ', function(name){
+ *         console.log('hi %s', name);
+ *       });
+ *
+ *       program.prompt('Description:', function(desc){
+ *         console.log('description was "%s"', desc.trim());
+ *       });
+ *
  * @param {String} str
  * @param {Function} fn
  * @api public
@@ -684,6 +700,13 @@ Command.prototype.prompt = function(str, fn){
 /**
  * Confirmation prompt with `str` and callback `fn(bool)`
  *
+ * Examples:
+ *
+ *      program.confirm('continue? ', function(ok){
+ *        console.log(' got %j', ok);
+ *        process.stdin.destroy();
+ *      });
+ *
  * @param {String} str
  * @param {Function} fn
  * @api public