[gnome-panel/wip/muktupavels/help-about: 2/5] libgnome-panel: update gp_applet_info_set_help_uri doc

[Alberts Muktupāvels <muktupavels src gnome org>]

commit 018c42c6a690e22bbbcf22ad42a281e70a4be3ee
Author: Alberts Muktupāvels <alberts muktupavels gmail com>
Date:   Thu Apr 2 22:09:15 2020 +0300

    libgnome-panel: update gp_applet_info_set_help_uri doc

 libgnome-panel/gp-applet-info.c | 3 ++-
 libgnome-panel/gp-module.c      | 2 +-
 2 files changed, 3 insertions(+), 2 deletions(-)
---
diff --git a/libgnome-panel/gp-applet-info.c b/libgnome-panel/gp-applet-info.c
index 7044fdb45..d93b688d3 100644
--- a/libgnome-panel/gp-applet-info.c
+++ b/libgnome-panel/gp-applet-info.c
@@ -84,7 +84,8 @@ gp_applet_info_set_initial_setup_dialog (GpAppletInfo             *info,
  * @info: a #GpAppletInfo
  * @help_uri: the help uri
  *
- * Sets the help uri.
+ * Sets the help uri. Must be in `help:<document>` format. Optional page
+ * identifier with options and anchor can be passed to gp_applet_show_help().
  */
 void
 gp_applet_info_set_help_uri (GpAppletInfo *info,
diff --git a/libgnome-panel/gp-module.c b/libgnome-panel/gp-module.c
index db4f1026c..f68e6ae00 100644
--- a/libgnome-panel/gp-module.c
+++ b/libgnome-panel/gp-module.c
@@ -45,7 +45,7 @@
  *                                  "example1-icon");
  *
  *       gp_applet_info_set_about_dialog (info, example1_setup_about);
- *       gp_applet_info_set_help_uri (info, "help:example/example1");
+ *       gp_applet_info_set_help_uri (info, "help:example");
  *     }
  *   else if (g_strcmp0 (id, "example2") == 0)
  *     {