alertdialog: Rephrase docs for show() a bit

In particular, discuss what to do about cancellables.

Related: !5326
This commit is contained in:
Benjamin Otte 2022-12-23 06:49:10 +01:00 committed by Matthias Clasen
parent 671fad5f34
commit c4c747d2ad

View File

@ -755,11 +755,13 @@ gtk_alert_dialog_choose_finish (GtkAlertDialog *self,
* @self: a `GtkAlertDialog`
* @parent: (nullable): the parent `GtkWindow`
*
* This function shows the alert to the user.
* Show the alert to the user.
*
* If the alert has more than one button, you should use
* [method@Gtk.AlertDialog.choose] instead and provide
* a callback that can react to the button that was clicked.
* This function is a simple version of [method@Gtk.AlertDialog.choose]
* intended for dialogs with a single button.
* If you want to cancel the dialog or if the alert has more than one button,
* you should use that function instead and provide it with a #GCancellable or
* callback respectively.
*
* Since: 4.10
*/