alertdialog: Rephrase docs for show() a bit
authorBenjamin Otte <otte@redhat.com>
Fri, 23 Dec 2022 05:49:10 +0000 (06:49 +0100)
committerMatthias Clasen <mclasen@redhat.com>
Sat, 24 Dec 2022 12:56:57 +0000 (07:56 -0500)
In particular, discuss what to do about cancellables.

Related: !5326

gtk/gtkalertdialog.c

index d4e0512a16158cd61f310f159ccd9795f49f6192..33ccac37d9b852386c1f85efa25cb6f25d9618c1 100644 (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
  */