From: João Távora <joaotavora@gmail.com>
Date: Wed, 23 Dec 2020 21:23:30 +0000 (+0000)
Subject: Rework docstring of hack-elisp-shorthands
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=d102e30618638d326fdbef2fd43dcc4919f6a793;p=emacs.git

Rework docstring of hack-elisp-shorthands

* lisp/international/mule.el (hack-elisp-shorthands): Rework
docstring.
---

diff --git a/lisp/international/mule.el b/lisp/international/mule.el
index 6e4492efdb9..deb801ff1af 100644
--- a/lisp/international/mule.el
+++ b/lisp/international/mule.el
@@ -295,7 +295,12 @@ attribute."
     (apply 'define-charset-internal name (mapcar 'cdr attrs))))
 
 (defun hack-elisp-shorthands (fullname)
-  "Return buffer-local value of `elisp-shorthands' in file FULLNAME."
+  "Return value of the `elisp-shorthands' file-local variable in FULLNAME.
+FULLNAME is the full name of an Elisp file which potentially
+specifies a file-local value for `elisp-shorthands'.  The Elisp
+code isn't read or evaluated in any way, we merely extract what
+the buffer-local value of `elisp-shorthands' would be if the file
+had been found by `find-file'."
   (let ((size (nth 7 (file-attributes fullname))))
     (with-temp-buffer
       (insert-file-contents fullname nil (max 0 (- size 3000)) size)