summaryrefslogtreecommitdiff
path: root/lisp/emacs-lisp
diff options
context:
space:
mode:
authorLars Ingebrigtsen <larsi@gnus.org>2019-07-27 12:04:53 +0200
committerLars Ingebrigtsen <larsi@gnus.org>2019-07-27 12:04:58 +0200
commit2cc5bb67ffde05384dfb4b7c24ea3e4255205390 (patch)
tree844153e102328b5514a72255331e1234bff8b0b5 /lisp/emacs-lisp
parentd04b0ae7b1c8edbf452bd40f5e50f8e750a66e06 (diff)
downloademacs-2cc5bb67ffde05384dfb4b7c24ea3e4255205390.tar.gz
emacs-2cc5bb67ffde05384dfb4b7c24ea3e4255205390.tar.bz2
emacs-2cc5bb67ffde05384dfb4b7c24ea3e4255205390.zip
define-derived-mode doc string clarification
* lisp/emacs-lisp/derived.el (define-derived-mode): Doc string clarification about the keywords (bug#26301).
Diffstat (limited to 'lisp/emacs-lisp')
-rw-r--r--lisp/emacs-lisp/derived.el8
1 files changed, 5 insertions, 3 deletions
diff --git a/lisp/emacs-lisp/derived.el b/lisp/emacs-lisp/derived.el
index ef9684e9284..dc867d61da3 100644
--- a/lisp/emacs-lisp/derived.el
+++ b/lisp/emacs-lisp/derived.el
@@ -123,11 +123,11 @@ PARENT: the name of the command for the parent mode (e.g. `text-mode')
NAME: a string which will appear in the status line (e.g. \"Hypertext\")
DOCSTRING: an optional documentation string--if you do not supply one,
the function will attempt to invent something useful.
+KEYWORDS: optional keywords.
BODY: forms to execute just before running the
hooks for the new mode. Do not use `interactive' here.
-BODY can start with keyword arguments; the following keywords are
-currently supported:
+The following keywords are currently supported:
:group GROUP
Declare the customization group that corresponds to this mode.
@@ -163,7 +163,9 @@ been generated automatically, with a reference to the keymap.
The new mode runs the hook constructed by the function
`derived-mode-hook-name'.
-See Info node `(elisp)Derived Modes' for more details."
+See Info node `(elisp)Derived Modes' for more details.
+
+\(fn CHILD PARENT NAME [DOCSTRING] [KEYWORDS...] &rest BODY)"
(declare (debug (&define name symbolp sexp [&optional stringp]
[&rest keywordp sexp] def-body))
(doc-string 4)