Update description of prompt (#1264)

* Update description of prompt Correct cache to store. Add that storage property can be specified as a string. Add that storage parameter is a fallback storage. * Improve description. Co-authored-by: Marcelo Shima <[email protected]>
yeoman · Jan 29, 2021 · 337dddf · 337dddf
1 parent bc08bee
commit 337dddf
Showing 1 changed file with 3 additions and 3 deletions.
diff --git a/lib/index.js b/lib/index.js
@@ -502,13 +502,13 @@ class Generator extends EventEmitter {
   /**
    * Prompt user to answer questions. The signature of this method is the same as {@link https://github.com/SBoudrias/Inquirer.js Inquirer.js}
    *
-   * On top of the Inquirer.js API, you can provide a `{cache: true}` property for
+   * On top of the Inquirer.js API, you can provide a `{store: true}` property for
    * every question descriptor. When set to true, Yeoman will store/fetch the
    * user's answers as defaults.
    *
    * @param  {object|object[]} questions  Array of question descriptor objects. See {@link https://github.com/SBoudrias/Inquirer.js/blob/master/README.md Documentation}
-   * @param  {Storage} [questions.storage] Store/fetch the question on the storage.
-   * @param  {Storage} [storage] Storage object
+   * @param  {Storage|String} [questions.storage] Storage object or name (generator property) to be used by the question to store/fetch the response.
+   * @param  {Storage|String} [storage] Storage object or name (generator property) to be used by default to store/fetch responses.
    * @return {Promise} prompt promise
    */
   prompt(questions, storage) {