]> git.eshelyaron.com Git - emacs.git/commitdiff
define-derived-mode doc string clarification
authorLars Ingebrigtsen <larsi@gnus.org>
Sat, 27 Jul 2019 10:04:53 +0000 (12:04 +0200)
committerLars Ingebrigtsen <larsi@gnus.org>
Sat, 27 Jul 2019 10:04:58 +0000 (12:04 +0200)
* lisp/emacs-lisp/derived.el (define-derived-mode): Doc string
clarification about the keywords (bug#26301).

lisp/emacs-lisp/derived.el

index ef9684e928485ac9594528621a7ed1c632bb31a1..dc867d61da30f747cc9e3a477bc9f800ec5eb228 100644 (file)
@@ -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)