[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

bug#5267: 23.1; doc string of defstruct

From: Drew Adams
Subject: bug#5267: 23.1; doc string of defstruct
Date: Thu, 24 Dec 2009 23:50:17 -0800

Doc string says:

"(defstruct (NAME OPTIONS...) (SLOT SLOT-OPTS...)...)"

That's not correct (not complete):
 (NAME OPTIONS...) can also be just NAME.
 (SLOT SLOT-OPTS...) can also be just SLOT.

Also, the rest of the doc string is not understandable:

"This macro defines a new Lisp data type called NAME, which contains data
stored in SLOTs.  This defines a `make-NAME' constructor, a `copy-NAME'
copier, a `NAME-p' predicate, and setf-able `NAME-SLOT' accessors."

NAME and SLOT are not described before this paragraph, and they are
not adequately described by the (incorrect) syntax description.
"Stored in SLOTs" should be "Stored in slots" (cannot substitute for
the parameter name to get anything that makes sense).  And what a slot
is needs to be explained a bit (minimal description).

In GNU Emacs 23.1.1 (i386-mingw-nt5.1.2600)
 of 2009-07-29 on SOFT-MJASON
Windowing system distributor `Microsoft Corp.', version 5.1.2600
configured using `configure --with-gcc (4.4)'

reply via email to

[Prev in Thread] Current Thread [Next in Thread]