diff options
| author | Lars Ingebrigtsen | 2019-07-27 12:04:53 +0200 |
|---|---|---|
| committer | Lars Ingebrigtsen | 2019-07-27 12:04:58 +0200 |
| commit | 2cc5bb67ffde05384dfb4b7c24ea3e4255205390 (patch) | |
| tree | 844153e102328b5514a72255331e1234bff8b0b5 | |
| parent | d04b0ae7b1c8edbf452bd40f5e50f8e750a66e06 (diff) | |
| download | emacs-2cc5bb67ffde05384dfb4b7c24ea3e4255205390.tar.gz 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).
| -rw-r--r-- | lisp/emacs-lisp/derived.el | 8 |
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') | |||
| 123 | NAME: a string which will appear in the status line (e.g. \"Hypertext\") | 123 | NAME: a string which will appear in the status line (e.g. \"Hypertext\") |
| 124 | DOCSTRING: an optional documentation string--if you do not supply one, | 124 | DOCSTRING: an optional documentation string--if you do not supply one, |
| 125 | the function will attempt to invent something useful. | 125 | the function will attempt to invent something useful. |
| 126 | KEYWORDS: optional keywords. | ||
| 126 | BODY: forms to execute just before running the | 127 | BODY: forms to execute just before running the |
| 127 | hooks for the new mode. Do not use `interactive' here. | 128 | hooks for the new mode. Do not use `interactive' here. |
| 128 | 129 | ||
| 129 | BODY can start with keyword arguments; the following keywords are | 130 | The following keywords are currently supported: |
| 130 | currently supported: | ||
| 131 | 131 | ||
| 132 | :group GROUP | 132 | :group GROUP |
| 133 | Declare the customization group that corresponds to this mode. | 133 | Declare the customization group that corresponds to this mode. |
| @@ -163,7 +163,9 @@ been generated automatically, with a reference to the keymap. | |||
| 163 | The new mode runs the hook constructed by the function | 163 | The new mode runs the hook constructed by the function |
| 164 | `derived-mode-hook-name'. | 164 | `derived-mode-hook-name'. |
| 165 | 165 | ||
| 166 | See Info node `(elisp)Derived Modes' for more details." | 166 | See Info node `(elisp)Derived Modes' for more details. |
| 167 | |||
| 168 | \(fn CHILD PARENT NAME [DOCSTRING] [KEYWORDS...] &rest BODY)" | ||
| 167 | (declare (debug (&define name symbolp sexp [&optional stringp] | 169 | (declare (debug (&define name symbolp sexp [&optional stringp] |
| 168 | [&rest keywordp sexp] def-body)) | 170 | [&rest keywordp sexp] def-body)) |
| 169 | (doc-string 4) | 171 | (doc-string 4) |