bug#46523: cl-struct-sequence-type documentation is incorrect

bug#46523: cl-struct-sequence-type documentation is incorrect

[Stefan Kangas]

Michael <sp1ff@pobox.com> writes:

> Package: cl-macs
> Version: 2.02
>
> `cl-struct-sequence-type' states that it will "Return `record',
> `vector`, or `list' if STRUCT-TYPE is a struct type, nil
> otherwise." This is incorrect: it will return `vector' or `list'
> if the argument was declared with those types, but if the struct
> type was defaulted to `record' it will return nil. If the
> argument is not a struct type the function errors.
>
> This is due to the fact that `cl-struct-define' has the following
> clause:
>
>    (if (eq type 'record)
>        ;; Defstruct using record objects.
>        (setq type nil))
>
> before `type' is passed to `cl--struct-new-class'
> (cf. cl-preloaded.el).
>
> I'm happy to submit a PR updating the docstring for
> `cl-struct-sequence-type', but wanted to verify that this is the
> desired behavior first (i.e. returning nil if the type is `record').

Does anyone who knows more about this have an opinion here?

bug#46523: cl-struct-sequence-type documentation is incorrect

[Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors]

> Does anyone who knows more about this have an opinion here?

Returning nil sounds fine to me,


        Stefan

bug#46523: cl-struct-sequence-type documentation is incorrect

[Lars Ingebrigtsen]

Stefan Monnier <monnier@iro.umontreal.ca> writes:

>> Does anyone who knows more about this have an opinion here?
>
> Returning nil sounds fine to me,

So I've now updated the doc string here on the emacs-28 branch.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no