From d45b3e03c96813e10f8de3c375a5310c01623dab Mon Sep 17 00:00:00 2001 From: Eli Zaretskii Date: Mon, 27 Sep 2021 09:49:28 +0300 Subject: [PATCH] Minor fixes of Lisp doc strings for shorthands feature * lisp/progmodes/elisp-mode.el (obarray-cache) (elisp--completion-local-symbols): * lisp/international/mule.el (hack-elisp-shorthands) (load-with-shorthands-and-code-conversion): Doc string fixes. --- lisp/international/mule.el | 11 ++++++----- lisp/progmodes/elisp-mode.el | 11 +++++------ 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/lisp/international/mule.el b/lisp/international/mule.el index 6c73600e208..2298af42b28 100644 --- a/lisp/international/mule.el +++ b/lisp/international/mule.el @@ -296,11 +296,10 @@ attribute." (defun hack-elisp-shorthands (fullname) "Return value of the `elisp-shorthands' file-local variable in FULLNAME. -FULLNAME is the absolute file name of an Elisp file which +FULLNAME is the absolute file name of an Elisp .el 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'." +The Elisp code in FULLNAME isn't read or evaluated in any way, except +for extraction of the buffer-local value of `elisp-shorthands'." (let ((size (nth 7 (file-attributes fullname)))) (with-temp-buffer (insert-file-contents fullname nil (max 0 (- size 3000)) size) @@ -380,7 +379,9 @@ Return t if file exists." t))) (defun load-with-shorthands-and-code-conversion (fullname file noerror nomessage) - "As `load-with-code-conversion', also considering Elisp shorthands." + "Like `load-with-code-conversion', but also consider Elisp shorthands. +This function uses shorthands defined in the file FULLNAME's local +value of `elisp-shorthands', when it processes that file's Elisp code." (let ((elisp-shorthands (hack-elisp-shorthands fullname))) (load-with-code-conversion fullname file noerror nomessage))) diff --git a/lisp/progmodes/elisp-mode.el b/lisp/progmodes/elisp-mode.el index d2ea25d67b0..acf7123225f 100644 --- a/lisp/progmodes/elisp-mode.el +++ b/lisp/progmodes/elisp-mode.el @@ -533,14 +533,13 @@ It can be quoted, or be inside a quoted form." ((facep sym) (find-definition-noselect sym 'defface))))) (defvar obarray-cache nil - "Hash table of obarray-related cache, or nil. -If non-nil this variable is a hash-table holding information -specific to the current state of the Elisp obarray. If the -obarray changes by any means (interning or uninterning a symbol), -the variable is immediately set to nil.") + "If non-nil, a hash table of cached obarray-related information. +The cache holds information specific to the current state of the +Elisp obarray. If the obarray is modified by any means (such as +interning or uninterning a symbol), this variable is set to nil.") (defun elisp--completion-local-symbols () - "Compute collections all Elisp symbols for completion purposes. + "Compute collections of all Elisp symbols for completion purposes. The return value is compatible with the COLLECTION form described in `completion-at-point-functions' (which see)." (cl-flet ((obarray-plus-shorthands () -- 2.39.5