From: Yuuki Harano <masm+github@masm11.me>
Date: Mon, 16 Aug 2021 12:50:32 +0000 (+0900)
Subject: * lisp/term/pgtk-win.el (pgtk-preedit-text): Write doc string
X-Git-Tag: emacs-29.0.90~3673
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=2e561ab2276820896e6c1dd13406bfe9047bd1dc;p=emacs.git

* lisp/term/pgtk-win.el (pgtk-preedit-text): Write doc string
---

diff --git a/lisp/term/pgtk-win.el b/lisp/term/pgtk-win.el
index f4247b030b2..3df450070c2 100644
--- a/lisp/term/pgtk-win.el
+++ b/lisp/term/pgtk-win.el
@@ -319,7 +319,11 @@ See the documentation of `create-fontset-from-fontset-spec' for the format.")
 
 (defvar pgtk-preedit-overlay nil)
 
-(defun pgtk-preedit-text (e)
+(defun pgtk-preedit-text (event)
+  "An internal function to display preedit text from input method.
+
+EVENT is an event of PGTK_PREEDIT_TEXT_EVENT.
+It contains colors and texts."
   (interactive "e")
   (when pgtk-preedit-overlay
     (delete-overlay pgtk-preedit-overlay))
@@ -328,7 +332,7 @@ See the documentation of `create-fontset-from-fontset-spec' for the format.")
   (let ((ovstr "")
         (idx 0)
         atts ov str color face-name)
-    (dolist (part (nth 1 e))
+    (dolist (part (nth 1 event))
       (setq str (car part))
       (setq face-name (intern (format "pgtk-im-%d" idx)))
       (eval