From 03601cb794b54be6124649f97f9568e6979c3287 Mon Sep 17 00:00:00 2001
From: Matthias Clasen <mclasen@redhat.com>
Date: Thu, 23 Jul 2020 12:57:08 -0400
Subject: docs: Improve shortcut trigger docs

Point out the need to escape <> in xml.
---
 gtk/gtkshortcuttrigger.c | 4 ++++
 1 file changed, 4 insertions(+)

(limited to 'gtk/gtkshortcuttrigger.c')

diff --git a/gtk/gtkshortcuttrigger.c b/gtk/gtkshortcuttrigger.c
index 65e3164b5b..8364932c59 100644
--- a/gtk/gtkshortcuttrigger.c
+++ b/gtk/gtkshortcuttrigger.c
@@ -122,6 +122,10 @@ gtk_shortcut_trigger_trigger (GtkShortcutTrigger *self,
  *   - two valid trigger strings, separated by a `|` character, for a
  *     #GtkAlternativeTrigger: `<Control>q|<Control>w`
  *
+ * Note that you will have to escape the `<` and `>` characters when specifying
+ * triggers in XML files, such as GtkBuilder ui files. Use `&lt;` instead of
+ * `<` and `&gt;` instead of `>`.
+ *
  * Returns: (nullable) (transfer full): a new #GtkShortcutTrigger
  *   or %NULL on error
  */
-- 
cgit v1.2.1