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).
This commit is contained in:
Lars Ingebrigtsen 2022-06-17 16:48:02 +02:00
parent 017bdb1611
commit d671cd57c4

View file

@ -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)))