From: Lars Ingebrigtsen <larsi@gnus.org>
Date: Fri, 17 Jun 2022 14:48:02 +0000 (+0200)
Subject: Update cl-struct-sequence-type doc string
X-Git-Tag: emacs-28.1.90~26
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=d671cd57c488ec792997fd4051440187dec3434f;p=emacs.git

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

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