From: Po Lu <luangruo@yahoo.com>
Date: Fri, 7 Jan 2022 09:23:25 +0000 (+0800)
Subject: Improve documentation of the preedit-text event
X-Git-Tag: emacs-29.0.90~3217
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=f041d610083ca0815ab18c589f115bacc523b9bb;p=emacs.git

Improve documentation of the preedit-text event

* doc/lispref/commands.texi (Misc Events): Document how
`preedit-text' events are used.
---

diff --git a/doc/lispref/commands.texi b/doc/lispref/commands.texi
index eb364d2f49a..062b8ea9116 100644
--- a/doc/lispref/commands.texi
+++ b/doc/lispref/commands.texi
@@ -2140,7 +2140,9 @@ cursor.  It can be @code{nil}, which means to remove any text
 previously displayed.  @c FIXME: what is the value of ARG on PGTK?
 
 This is a special event (@pxref{Special Events}), which normally
-should not be bound by the user to any command.
+should not be bound by the user to any command.  Emacs will typically
+the text contained in the event behind the cursor on-screen when it is
+received.
 
 @cindex @code{drag-n-drop} event
 @item (drag-n-drop @var{position} @var{files})