From: Jambunathan K <kjambunathan@gmail.com>
To: "Drew Adams" <drew.adams@oracle.com>
Cc: 13572@debbugs.gnu.org
Subject: bug#13572: 24.3.50; `describe-function' -> "This function has a compiler macro..."
Date: Mon, 28 Jan 2013 13:38:55 +0530 [thread overview]
Message-ID: <87sj5lpw4o.fsf@gmail.com> (raw)
In-Reply-To: <6E0A1C25FDBF47CC8ABE955745D42FB6@us.oracle.com> (Drew Adams's message of "Sun, 27 Jan 2013 22:26:13 -0800")
"Drew Adams" <drew.adams@oracle.com> writes:
>> 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.
+1
I ran in to the some confusion while looking at compile.el - constructs
like `compilation--message->loc' which are reported as compiler macros
(Part of the confusion may be because of my ignorance. Only "macros"
that I know of is `defmacros')
,----
| (cl-defstruct (compilation--message
| (:constructor nil)
| (:copier nil)
| ;; (:type list) ;Old representation.
| (:constructor compilation--make-message (loc type end-loc))
| (:conc-name compilation--message->))
| loc type end-loc)
`----
Enhanced docstring can educate ignorant people like me...
--
prev parent reply other threads:[~2013-01-28 8:08 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
2013-01-28 8:08 ` Jambunathan K [this message]
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=87sj5lpw4o.fsf@gmail.com \
--to=kjambunathan@gmail.com \
--cc=13572@debbugs.gnu.org \
--cc=drew.adams@oracle.com \
/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.