[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
bug#13572: 24.3.50; `describe-function' -> "This function has a compiler
From: |
Jambunathan K |
Subject: |
bug#13572: 24.3.50; `describe-function' -> "This function has a compiler macro..." |
Date: |
Mon, 28 Jan 2013 13:38:55 +0530 |
User-agent: |
Gnus/5.13 (Gnus v5.13) Emacs/24.3.50 (gnu/linux) |
"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...
--