From bdb668ba5457ef04a054a9cf0d9edeee4ccbabf3 Mon Sep 17 00:00:00 2001
From: Tim Allen <screwtape@froup.com>
Date: Fri, 11 Jun 2021 00:27:13 +1000
Subject: [PATCH] Document how to escape special characters in completions.

---
 doc/pages/options.asciidoc | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/doc/pages/options.asciidoc b/doc/pages/options.asciidoc
index c12c9721..c985b8f9 100644
--- a/doc/pages/options.asciidoc
+++ b/doc/pages/options.asciidoc
@@ -143,6 +143,9 @@ are exclusively available to built-in options.
     except for the first element which follows the
     `<line>.<column>[+<length>]@<timestamp>` format to define where the
     completion apply in the buffer.
+    Any `|` or `\` characters that occur within the `<text>`,
+    `<select cmd>`, or `<menu text>` fields should be escaped as `\|`
+    or `\\`.
 
     Select commands are arbitrary Kakoune commands that will be executed
     each time the element is selected in the menu. The common use case is