]> git.eshelyaron.com Git - emacs.git/commitdiff
Update cl-struct-sequence-type doc string
authorLars Ingebrigtsen <larsi@gnus.org>
Fri, 17 Jun 2022 14:48:02 +0000 (16:48 +0200)
committerLars Ingebrigtsen <larsi@gnus.org>
Fri, 17 Jun 2022 14:48:02 +0000 (16:48 +0200)
* lisp/emacs-lisp/cl-macs.el (cl-struct-sequence-type): Fix doc
string to reflect what it does (bug#46523).

lisp/emacs-lisp/cl-macs.el

index c27a43f3baf9a66e225efbc3b3e5fddb7c6eeabc..85ebcaade7194efa8b6c2dd4cb4a29d62681c8e8 100644 (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)))