diff options
author | Eli Zaretskii <eliz@gnu.org> | 2022-05-06 15:15:27 +0300 |
---|---|---|
committer | Eli Zaretskii <eliz@gnu.org> | 2022-05-06 15:15:27 +0300 |
commit | 92bbe911e99968c04509c553767fa83bfdcbeb18 (patch) | |
tree | 50fd9b2d4da4f92644642265f9b1a36a1c85f274 /lisp/emacs-lisp | |
parent | 7601a77d8a6ab567bd221777ca2964c934e1e4b9 (diff) | |
download | emacs-92bbe911e99968c04509c553767fa83bfdcbeb18.tar.gz emacs-92bbe911e99968c04509c553767fa83bfdcbeb18.tar.bz2 emacs-92bbe911e99968c04509c553767fa83bfdcbeb18.zip |
; Improve documentation of 'buffer-local-set-state'
* lisp/emacs-lisp/easy-mmode.el (buffer-local-set-state)
(buffer-local-restore-state): Doc fixes.
* doc/lispref/modes.texi (Defining Minor Modes): Fix a typo and
improve wording and indexing.
Diffstat (limited to 'lisp/emacs-lisp')
-rw-r--r-- | lisp/emacs-lisp/easy-mmode.el | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/lisp/emacs-lisp/easy-mmode.el b/lisp/emacs-lisp/easy-mmode.el index bade14ec3d8..2568eaeb76a 100644 --- a/lisp/emacs-lisp/easy-mmode.el +++ b/lisp/emacs-lisp/easy-mmode.el @@ -827,9 +827,9 @@ Interactively, COUNT is the prefix numeric argument, and defaults to 1." (defmacro buffer-local-set-state (&rest pairs) - "Like `setq-local', but return an object that allows restoring previous state. -Use `buffer-local-restore-state' on the returned object to -restore the state. + "Like `setq-local', but allow restoring the previous state of locals later. +This macro returns an object that can be passed to `buffer-local-restore-state' +in order to restore the state of the local variables set via this macro. \(fn [VARIABLE VALUE]...)" (declare (debug setq)) @@ -854,8 +854,8 @@ restore the state. ;;;###autoload (defun buffer-local-restore-state (states) - "Restore buffer local variable values in STATES. -STATES is an object returned by `buffer-local-set-state'." + "Restore values of buffer-local variables recorded in STATES. +STATES should be an object returned by `buffer-local-set-state'." (pcase-dolist (`(,variable ,local ,value) states) (if local (set variable value) |