diff --git a/docs/api.md b/docs/api.md index 5e2224cd4..def8e6a37 100644 --- a/docs/api.md +++ b/docs/api.md @@ -1205,7 +1205,9 @@ parser.parse(bot.userText, function (err, argv, output) { }) ``` -***Note:*** Providing a callback to `parse()` disables the [`exitProcess` setting](#exitprocess) until after the callback is invoked. +***Note:*** Providing a callback to `parse()` prevents Yargs from exiting +automatically while there is still work in the event loop, as if the +[`exitProcess` setting](#exitprocess) were set to `false`. ***Note:*** the `output` parameter of a `parse()` callback only contains text output by yargs using its internal logger. It *does not* include any text output by user-supplied callback, such as `console.log()` outputs in a