diff options
author | Alan Mackenzie <acm@muc.de> | 2024-05-28 20:12:17 +0000 |
---|---|---|
committer | Alan Mackenzie <acm@muc.de> | 2024-05-28 20:12:17 +0000 |
commit | 0999c64fa861bf9b5200b6dae09e81563853a04c (patch) | |
tree | bbbb7eb33efaa56995f1d992d2a6bc28b0ec9691 /lisp | |
parent | 066e9b598858cc4c0b666b12242f07a7fdf3e073 (diff) | |
download | emacs-0999c64fa861bf9b5200b6dae09e81563853a04c.tar.gz emacs-0999c64fa861bf9b5200b6dae09e81563853a04c.tar.bz2 emacs-0999c64fa861bf9b5200b6dae09e81563853a04c.zip |
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.
Diffstat (limited to 'lisp')
-rw-r--r-- | lisp/files.el | 17 |
1 files changed, 9 insertions, 8 deletions
diff --git a/lisp/files.el b/lisp/files.el index ae6dc1d6b29..079d48e69fb 100644 --- a/lisp/files.el +++ b/lisp/files.el @@ -3570,17 +3570,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.") |