all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: "Drew Adams" <drew.adams@oracle.com>
To: <13572@debbugs.gnu.org>
Subject: bug#13572: 24.3.50; `describe-function' -> "This function has a compiler macro..."
Date: Sun, 27 Jan 2013 22:26:13 -0800	[thread overview]
Message-ID: <6E0A1C25FDBF47CC8ABE955745D42FB6@us.oracle.com> (raw)
In-Reply-To: <3F8F12B8F6B54805B9D0F822360663D6@us.oracle.com>

> this is a type predicate constructed
> automatically for a register defstruct.
> 
> The doc needs to be improved for this kind of thing 
> (automatically generated functions).

I guess Common Lisp defstruct does not allow for a doc string for the generated
predicate (unlike the case for slots, constructor functions, and the defstruct
itself).

It would be good if Emacs Lisp could automatically generate a minimal doc string
for the predicate that at least referred to the structure.  Something like this:

 "Type predicate for a NAME structure."

where NAME is the defstruct name.

I guess that would be a wishlist item, since this is not part of the CL spec.

Apart from that, in this particular defstruct it would be good to at least add
doc strings for those things that allow it.  A doc string for the defstruct
itself is the least users could ask for.






  reply	other threads:[~2013-01-28  6:26 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2013-01-28  2:39 bug#13572: 24.3.50; `describe-function' -> "This function has a compiler macro..." Drew Adams
2013-01-28  2:44 ` Drew Adams
2013-01-28  6:26   ` Drew Adams [this message]
2013-01-28  8:08     ` Jambunathan K

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=6E0A1C25FDBF47CC8ABE955745D42FB6@us.oracle.com \
    --to=drew.adams@oracle.com \
    --cc=13572@debbugs.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.