From: Alan Mackenzie <acm@muc.de>
Date: Tue, 28 May 2024 20:12:17 +0000 (+0000)
Subject: Correct and clarify two doc strings in lisp/files.el
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=6d1ed7da09804e0476919b910a22ef7e150bdb93;p=emacs.git

Correct and clarify two doc strings in lisp/files.el

lisp/files.el (major-mode-remap-alist)
(major-mode-remap-defaults): Correct and clarify the doc
strings.

(cherry picked from commit 0999c64fa861bf9b5200b6dae09e81563853a04c)
---

diff --git a/lisp/files.el b/lisp/files.el
index 7fee742c68b..bfdb2eb64d9 100644
--- a/lisp/files.el
+++ b/lisp/files.el
@@ -3591,17 +3591,18 @@ we don't actually set it to the same mode the buffer already has."
   "Remember the mode we have set via `set-auto-mode-0'.")
 
 (defcustom major-mode-remap-alist nil
-  "Alist mapping file-specified mode to actual mode.
-Every entry is of the form (MODE . FUNCTION) which means that in order
-to activate the major mode MODE (specified via something like
-`auto-mode-alist', file-local variables, ...) we should actually call
-FUNCTION instead.
-FUNCTION can be nil to hide other entries (either in this var or in
-`major-mode-remap-defaults') and means that we should call MODE."
+  "Alist mapping file-specified modes to alternative modes.
+Each entry is of the form (MODE . FUNCTION) which means that in place
+of activating the major mode MODE (specified via something like
+`auto-mode-alist', file-local variables, ...) we actually call FUNCTION
+instead.
+FUNCTION is typically a major mode which \"does the same thing\" as
+MODE, but can also be nil to hide other entries (either in this var or
+in `major-mode-remap-defaults') and means that we should call MODE."
   :type '(alist (symbol) (function)))
 
 (defvar major-mode-remap-defaults nil
-  "Alist mapping file-specified mode to actual mode.
+  "Alist mapping file-specified modes to alternative modes.
 This works like `major-mode-remap-alist' except it has lower priority
 and it is meant to be modified by packages rather than users.")