From: Eli Zaretskii <eliz@gnu.org>
Date: Sun, 2 Oct 2022 13:21:05 +0000 (+0300)
Subject: ; Improve doc string of 'with-locale-environment'
X-Git-Tag: emacs-29.0.90~1856^2~82
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=b69f640b316bdeac253d0fec09fb2649c8b900e9;p=emacs.git

; Improve doc string of 'with-locale-environment'

* lisp/international/mule-cmds.el (with-locale-environment): Doc
fix.
---

diff --git a/lisp/international/mule-cmds.el b/lisp/international/mule-cmds.el
index 8bece9a3ee6..48e5c9aa1fe 100644
--- a/lisp/international/mule-cmds.el
+++ b/lisp/international/mule-cmds.el
@@ -2664,7 +2664,13 @@ For example, translate \"swedish\" into \"sv_SE.ISO8859-1\"."
   "The currently set locale environment.")
 
 (defmacro with-locale-environment (locale-name &rest body)
-  "Execute BODY with the locale set to LOCALE-NAME."
+  "Execute BODY with the locale set to LOCALE-NAME.
+
+Note that changing the locale modifies settings that affect
+the display, such as `terminal-coding-system' and `standard-display-table',
+but this macro does not by itself perform redisplay.  If BODY needs to
+display something with LOCALE-NAME's settings, include a call
+to `redraw-frame' in BODY."
   (declare (indent 1) (debug (sexp def-body)))
   (let ((current (gensym)))
     `(let ((,current current-locale-environment))