[gnome-shell/wip/re-search-v2: 4/28] remote-search: document a 'description' key in the meta dictionary

[Cosimo Cecchi <cosimoc src gnome org>]

commit ec44d354d138d6e8c55e0d40e5099137aee52130
Author: Tanner Doshier <doshitan gmail com>
Date:   Mon Nov 26 17:15:57 2012 -0500

    remote-search: document a 'description' key in the meta dictionary
    
    This can be specified by the provider and will be displayed in the
    search results.

 data/org.gnome.ShellSearchProvider.xml |   10 +++++++---
 1 files changed, 7 insertions(+), 3 deletions(-)
---
diff --git a/data/org.gnome.ShellSearchProvider.xml b/data/org.gnome.ShellSearchProvider.xml
index 4bf3076..fed1f91 100644
--- a/data/org.gnome.ShellSearchProvider.xml
+++ b/data/org.gnome.ShellSearchProvider.xml
@@ -113,9 +113,13 @@
           <doc:summary>
             <doc:para>
               A dictionary describing the given search result, containing
-              'id', 'name' (both strings) and either 'icon' (a serialized
-              GIcon) or 'icon-data' (raw image data as (iiibiiay) - width,
-              height, rowstride, has-alpha, bits per sample, channels, data)
+              'id' and 'name' (both strings). Optionally, either 'gicon' (a
+              serialized GIcon) or 'icon-data' (raw image data as (iiibiiay)
+              - width, height, rowstride, has-alpha, bits per sample,
+              channels, data) can be specified if the result can be better
+              served with a thumbnail of the content (such as with images).
+              A 'description' field (string) may also be specified if more
+              context would help the user find the desired result.
             </doc:para>
           </doc:summary>
         </doc:doc>