[gnome-software: 5/6] docs: Update description of icon loading in the plugin documentation




commit fd301848678df08732ea1340aec8203636c5d39a
Author: Philip Withnall <pwithnall endlessos org>
Date:   Sun Mar 14 16:16:16 2021 +0000

    docs: Update description of icon loading in the plugin documentation
    
    It’s become outdated with the changes in #1147.
    
    Signed-off-by: Philip Withnall <pwithnall endlessos org>

 doc/api/gnome-software-docs.xml | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)
---
diff --git a/doc/api/gnome-software-docs.xml b/doc/api/gnome-software-docs.xml
index 5d6c42385..a96fd65ab 100644
--- a/doc/api/gnome-software-docs.xml
+++ b/doc/api/gnome-software-docs.xml
@@ -270,8 +270,11 @@ gs_plugin_add_installed (GsPlugin *plugin,
           </listitem>
           <listitem>
             <para>
-              The <code>icons</code> plugin will take the stock icon and convert
-              it to a pixbuf of the correct size.
+              The icon will be loaded into a pixbuf of the correct size when
+              needed by the UI. You must ensure that icons are available at
+              common sizes. For icons of type <code>GsRemoteIcon</code>, the
+              <code>icons</code> plugin will download and cache the icon
+              locally.
             </para>
           </listitem>
         </itemizedlist>


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