all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: "Drew Adams" <drew.adams@oracle.com>
To: <bug-gnu-emacs@gnu.org>
Subject: bug#5267: 23.1; doc string of defstruct
Date: Thu, 24 Dec 2009 23:50:17 -0800	[thread overview]
Message-ID: <C2B0686AAAC24E96BDF11F94096F221F@us.oracle.com> (raw)

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	other threads:[~2009-12-25  7:50 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2009-12-25  7:50 Drew Adams [this message]
  -- strict thread matches above, loose matches on Subject: below --
2009-10-06 18:46 bug#4655: 23.1.50; buffer-swap-text oddity Markus Rost
2010-01-16 20:05 ` bug#5267: 23.1; doc string of defstruct Chong Yidong

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=C2B0686AAAC24E96BDF11F94096F221F@us.oracle.com \
    --to=drew.adams@oracle.com \
    --cc=5267@debbugs.gnu.org \
    --cc=bug-gnu-emacs@gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this external index

	https://git.savannah.gnu.org/cgit/emacs.git
	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.