summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLars Ingebrigtsen <larsi@gnus.org>2022-06-17 16:48:02 +0200
committerLars Ingebrigtsen <larsi@gnus.org>2022-06-17 16:48:02 +0200
commitd671cd57c488ec792997fd4051440187dec3434f (patch)
tree2385abc10ae53ff739694f2076cfe57cdc01f53a
parent017bdb161141c0b5f3981a124bdeadc17a20a558 (diff)
downloademacs-d671cd57c488ec792997fd4051440187dec3434f.tar.gz
Update cl-struct-sequence-type doc string
* lisp/emacs-lisp/cl-macs.el (cl-struct-sequence-type): Fix doc string to reflect what it does (bug#46523).
-rw-r--r--lisp/emacs-lisp/cl-macs.el5
1 files changed, 3 insertions, 2 deletions
diff --git a/lisp/emacs-lisp/cl-macs.el b/lisp/emacs-lisp/cl-macs.el
index c27a43f3baf..85ebcaade71 100644
--- a/lisp/emacs-lisp/cl-macs.el
+++ b/lisp/emacs-lisp/cl-macs.el
@@ -3288,8 +3288,9 @@ the form NAME which is a shorthand for (NAME NAME)."
(defun cl-struct-sequence-type (struct-type)
"Return the sequence used to build STRUCT-TYPE.
-STRUCT-TYPE is a symbol naming a struct type. Return `record',
-`vector', or `list' if STRUCT-TYPE is a struct type, nil otherwise."
+STRUCT-TYPE is a symbol naming a struct type. Return values are
+either `vector', `list' or nil (and the latter indicates a
+`record' struct type."
(declare (side-effect-free t) (pure t))
(cl--struct-class-type (cl--struct-get-class struct-type)))