SpinButton: Fix an obviously wrong arg description
authorDaniel Boles <dboles.src@gmail.com>
Sat, 26 May 2018 00:06:00 +0000 (01:06 +0100)
committerDaniel Boles <dboles.src@gmail.com>
Sat, 26 May 2018 00:06:00 +0000 (01:06 +0100)
:climb-rate is not about what you get when you single-click on a button,
as this implied: it's what happens if you hold down a button or a key.
Fix the description of @climb_rate to new(), and while here, mention the
key in the blurb of :climb-rate itself.

gtk/gtkspinbutton.c

index 7b5cd7c5caa4c2a7285a455471eb080a9d91bf12..6a88e40a7dc1287315793227c78291edd0fd242e 100644 (file)
@@ -338,7 +338,7 @@ gtk_spin_button_class_init (GtkSpinButtonClass *class)
                                    PROP_CLIMB_RATE,
                                    g_param_spec_double ("climb-rate",
                                                         P_("Climb Rate"),
-                                                        P_("The acceleration rate when you hold down a button"),
+                                                        P_("The acceleration rate when you hold down a button or key"),
                                                         0.0, G_MAXDOUBLE, 0.0,
                                                         GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY));
 
@@ -1594,8 +1594,8 @@ gtk_spin_button_configure (GtkSpinButton *spin_button,
  * gtk_spin_button_new:
  * @adjustment: (allow-none): the #GtkAdjustment object that this spin
  *     button should use, or %NULL
- * @climb_rate: specifies how much the spin button changes when an arrow
- *     is clicked on
+ * @climb_rate: specifies by how much the rate of change in the value will
+ *     accelerate if you continue to hold down an up/down button or arrow key
  * @digits: the number of decimal places to display
  *
  * Creates a new #GtkSpinButton.