GNOME Bugzilla – Bug 618160
Documentation for gtk_combo_box_get_active_iter is unclear
Last modified: 2017-08-24 20:45:07 UTC
Suggested revision: At line 4939 of gtkcombobox.c /** * gtk_combo_box_get_active_iter: * @combo_box: A #GtkComboBox * @iter: A #GtkTreeIter * * Sets @iter to point to the current active item, if it exists. * * Return value: If an active item exists return %TRUE with @iter set to point to it. Else return %FALSE and leave @iter unchanged. * * Since: 2.4 */
Created attachment 160705 [details] [review] Elaborate on gtk_combo_box_get_activer_iter
Review of attachment 160705 [details] [review]: s/activer/active/ in the commit msg ::: gtk/gtkcombobox.c @@ +4976,2 @@ * @combo_box: A #GtkComboBox * @iter: The uninitialized #GtkTreeIter I would change this to something like "Address of a #GtkTreeIter"; being uninitialised is not required, and there might be some arguable use-case for having an initialised, valid iter and keeping its original value if returning FALSE. @@ +4977,3 @@ * @iter: The uninitialized #GtkTreeIter * + * Sets @iter to point to the currently active item, if it exists. Otherwise I would say "if any item is active", just to avoid any risk of people thinking "if it exists" means that @iter is nullable, which it is not.
Comment on attachment 160705 [details] [review] Elaborate on gtk_combo_box_get_activer_iter Thanks for the patch, which I adapted and pushed: