[gnome-software] lib: Tweak refine() documentation to no longer recommend refine_app()



commit 393bda160e998014009abcf2891f1ff42989e774
Author: Philip Withnall <withnall endlessm com>
Date:   Thu Apr 16 12:16:05 2020 +0100

    lib: Tweak refine() documentation to no longer recommend refine_app()
    
    `refine_app()` is less performant. See the preceding commits.
    
    Signed-off-by: Philip Withnall <withnall endlessm com>

 lib/gs-plugin-vfuncs.h | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
---
diff --git a/lib/gs-plugin-vfuncs.h b/lib/gs-plugin-vfuncs.h
index 4ae65e54..907bdc71 100644
--- a/lib/gs-plugin-vfuncs.h
+++ b/lib/gs-plugin-vfuncs.h
@@ -409,9 +409,9 @@ gboolean     gs_plugin_add_unvoted_reviews          (GsPlugin       *plugin,
  * @cancellable: a #GCancellable, or %NULL
  * @error: a #GError, or %NULL
  *
- * Adds required information to a list of #GsApp's.
- * This function is only really required when "batching up" requests, and most
- * plugins are better using the per-app gs_plugin_refine_app() function.
+ * Adds required information to a list of #GsApp's. It allows requests to be
+ * batched up, which allows better performance than individual calls to
+ * gs_plugin_refine_app(). It should be used in preference wherever possible.
  *
  * An example for when this is useful would be in the PackageKit plugin where
  * we want to do one transaction of GetDetails with multiple source-ids rather


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