[gtk+] scale: Really fix documentation of set_digits()



commit 494a38504b2af09f8df83844f592dd8d97eee223
Author: Daniel Boles <dboles src gnome org>
Date:   Thu Jan 19 00:44:35 2017 +0000

    scale: Really fix documentation of set_digits()
    
    This previously only mentioned its effect on the displayed value, and
    even after the previous commit, its rounding of the actual value upon
    change still reads like too much of an afterthought. Worse, it wasn’t
    mentioned at all in the doc for the @digits parameter. Change this to
    emphasise rounding always occurs and the displayed value is secondary.

 gtk/gtkscale.c |    9 ++++-----
 1 files changed, 4 insertions(+), 5 deletions(-)
---
diff --git a/gtk/gtkscale.c b/gtk/gtkscale.c
index 3fb9186..dbe629d 100644
--- a/gtk/gtkscale.c
+++ b/gtk/gtkscale.c
@@ -1077,12 +1077,11 @@ gtk_scale_new_with_range (GtkOrientation orientation,
 /**
  * gtk_scale_set_digits:
  * @scale: a #GtkScale
- * @digits: the number of decimal places to display,
- *     e.g. use 1 to display 1.0, 2 to display 1.00, etc
+ * @digits: the number of decimal places to which the value will be rounded
  *
- * Sets the number of decimal places that are displayed in the value. Also
- * causes the value of the adjustment to be rounded to this number of digits
- * whenever it is changed, so the retrieved value matches the displayed one.
+ * Sets the number of decimal places to which the value is rounded when it is
+ * changed. This also sets the number of digits shown in the displayed value
+ * when using the default handler for the #GtkScale::format-value signal.
  *
  * Note that rounding to a small number of digits can interfere with
  * the smooth autoscrolling that is built into #GtkScale. As an alternative,


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]