docs(dialog): clarify promise rejection behavior in descriptions

Splaktar · Splaktar · commit 939f6c9f8ef1 · 2020-04-21T14:15:07.000-04:00
- improves prompt and confirm dialog descriptions Fixes #10130
diff --git a/src/components/dialog/dialog.js b/src/components/dialog/dialog.js
@@ -435,8 +435,9 @@ function MdDialogDirective($$rAF, $mdTheming, $mdDialog) {
  * @name $mdDialog#confirm
  *
  * @description
- * Builds a preconfigured dialog with the specified message. You can call show and the promise returned
- * will be resolved only if the user clicks the confirm action on the dialog.
+ * Builds a preconfigured dialog with the specified message. You can call show and the promise
+ * returned will be resolved if the user clicks the confirm action on the dialog. The promise will
+ * be rejected if the user clicks the cancel action or dismisses the dialog.
  *
  * @returns {obj} an `$mdDialogPreset` with the chainable configuration methods:
  *
@@ -460,8 +461,10 @@ function MdDialogDirective($$rAF, $mdTheming, $mdDialog) {
  * @name $mdDialog#prompt
  *
  * @description
- * Builds a preconfigured dialog with the specified message and input box. You can call show and the promise returned
- * will be resolved only if the user clicks the prompt action on the dialog, passing the input value as the first argument.
+ * Builds a preconfigured dialog with the specified message and input box. You can call show and the
+ * promise returned will be resolved, if the user clicks the prompt action on the dialog, passing
+ * the input value as the first argument. The promise will be rejected if the user clicks the cancel
+ * action or dismisses the dialog.
  *
  * @returns {obj} an `$mdDialogPreset` with the chainable configuration methods:
  *

Original file line number	Diff line number	Diff line change
`@@ -435,8 +435,9 @@ function MdDialogDirective($$rAF, $mdTheming, $mdDialog) {`
`435`	`435`	`* @name $mdDialog#confirm`
`436`	`436`	`*`
`437`	`437`	`* @description`
`438`		`- * Builds a preconfigured dialog with the specified message. You can call show and the promise returned`
`439`		`- * will be resolved only if the user clicks the confirm action on the dialog.`
	`438`	`+ * Builds a preconfigured dialog with the specified message. You can call show and the promise`
	`439`	`+ * returned will be resolved if the user clicks the confirm action on the dialog. The promise will`
	`440`	`+ * be rejected if the user clicks the cancel action or dismisses the dialog.`
`440`	`441`	`*`
`441`	`442`	* @returns {obj} an `$mdDialogPreset` with the chainable configuration methods:
`442`	`443`	`*`
`@@ -460,8 +461,10 @@ function MdDialogDirective($$rAF, $mdTheming, $mdDialog) {`
`460`	`461`	`* @name $mdDialog#prompt`
`461`	`462`	`*`
`462`	`463`	`* @description`
`463`		`- * Builds a preconfigured dialog with the specified message and input box. You can call show and the promise returned`
`464`		`- * will be resolved only if the user clicks the prompt action on the dialog, passing the input value as the first argument.`
	`464`	`+ * Builds a preconfigured dialog with the specified message and input box. You can call show and the`
	`465`	`+ * promise returned will be resolved, if the user clicks the prompt action on the dialog, passing`
	`466`	`+ * the input value as the first argument. The promise will be rejected if the user clicks the cancel`
	`467`	`+ * action or dismisses the dialog.`
`465`	`468`	`*`
`466`	`469`	* @returns {obj} an `$mdDialogPreset` with the chainable configuration methods:
`467`	`470`	`*`