From: Lars Ingebrigtsen <larsi@gnus.org>
Date: Sat, 27 Jul 2019 10:04:53 +0000 (+0200)
Subject: define-derived-mode doc string clarification
X-Git-Tag: emacs-27.0.90~1817^2~86
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=2cc5bb67ffde05384dfb4b7c24ea3e4255205390;p=emacs.git

define-derived-mode doc string clarification

* lisp/emacs-lisp/derived.el (define-derived-mode): Doc string
clarification about the keywords (bug#26301).
---

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)