From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Jambunathan K Newsgroups: gmane.emacs.bugs Subject: bug#13572: 24.3.50; `describe-function' -> "This function has a compiler macro..." Date: Mon, 28 Jan 2013 13:38:55 +0530 Message-ID: <87sj5lpw4o.fsf@gmail.com> References: <25708670B28E4172A0FC0979D00984FC@us.oracle.com> <3F8F12B8F6B54805B9D0F822360663D6@us.oracle.com> <6E0A1C25FDBF47CC8ABE955745D42FB6@us.oracle.com> NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain X-Trace: ger.gmane.org 1359360582 10934 80.91.229.3 (28 Jan 2013 08:09:42 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Mon, 28 Jan 2013 08:09:42 +0000 (UTC) Cc: 13572@debbugs.gnu.org To: "Drew Adams" Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Mon Jan 28 09:10:01 2013 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by plane.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1Tzjmy-0006uL-R6 for geb-bug-gnu-emacs@m.gmane.org; Mon, 28 Jan 2013 09:10:01 +0100 Original-Received: from localhost ([::1]:59856 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Tzjmg-00013U-V4 for geb-bug-gnu-emacs@m.gmane.org; Mon, 28 Jan 2013 03:09:42 -0500 Original-Received: from eggs.gnu.org ([208.118.235.92]:33003) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Tzjmd-00013O-V6 for bug-gnu-emacs@gnu.org; Mon, 28 Jan 2013 03:09:41 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1Tzjmc-0005XM-T5 for bug-gnu-emacs@gnu.org; Mon, 28 Jan 2013 03:09:39 -0500 Original-Received: from debbugs.gnu.org ([140.186.70.43]:46510) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Tzjmc-0005XG-Oe for bug-gnu-emacs@gnu.org; Mon, 28 Jan 2013 03:09:38 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.72) (envelope-from ) id 1Tzjn0-0007E2-C5 for bug-gnu-emacs@gnu.org; Mon, 28 Jan 2013 03:10:02 -0500 X-Loop: help-debbugs@gnu.org Resent-From: Jambunathan K Original-Sender: debbugs-submit-bounces@debbugs.gnu.org Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Mon, 28 Jan 2013 08:10:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 13572 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: Original-Received: via spool by 13572-submit@debbugs.gnu.org id=B13572.135936057727735 (code B ref 13572); Mon, 28 Jan 2013 08:10:02 +0000 Original-Received: (at 13572) by debbugs.gnu.org; 28 Jan 2013 08:09:37 +0000 Original-Received: from localhost ([127.0.0.1]:51974 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.72) (envelope-from ) id 1Tzjmb-0007DI-79 for submit@debbugs.gnu.org; Mon, 28 Jan 2013 03:09:37 -0500 Original-Received: from mail-pb0-f47.google.com ([209.85.160.47]:45288) by debbugs.gnu.org with esmtp (Exim 4.72) (envelope-from ) id 1TzjmY-0007DA-Mj for 13572@debbugs.gnu.org; Mon, 28 Jan 2013 03:09:35 -0500 Original-Received: by mail-pb0-f47.google.com with SMTP id rp8so558929pbb.34 for <13572@debbugs.gnu.org>; Mon, 28 Jan 2013 00:09:09 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; h=x-received:from:to:cc:subject:references:date:in-reply-to :message-id:user-agent:mime-version:content-type; bh=ZG3bLj6NpZGYWGdQh3WO2hjopXYSkFjtYSI6h+Y1I10=; b=wgCAEcElYolFvdmrakKsMGbm7proLzSyNgTn6GdoSMyH2szN30azuPNCjju2GMVVhw M7NpyjguAF7ErNIjbW8dqRsJCb08YtPB9ToUgP/qbardqNTLshWgSym9/TG3V8edM7Nf dpOyB3A+2cX4RhWf/23KnBOjVeuI60T4Ucr+2eh+PM+86xiWVS9P3TKLqibQtaPkQsz3 NybYifStK42NJ6dvG+dbrhFh3439jhTsp5KIR3Fvg4gc2ceHQlxzkRJbWpYDWFjEFfgT X90aBQy0g1VJmPHlS6gmh9nZjczVXF2RhM1pw4XTpu7p4Ojx8CKp1H5jpAcC9UAswTiU FiXg== X-Received: by 10.68.223.135 with SMTP id qu7mr35850037pbc.134.1359360549713; Mon, 28 Jan 2013 00:09:09 -0800 (PST) Original-Received: from debian-6.05 ([115.242.131.195]) by mx.google.com with ESMTPS id p9sm6294667pao.29.2013.01.28.00.09.06 (version=TLSv1.1 cipher=RC4-SHA bits=128/128); Mon, 28 Jan 2013 00:09:08 -0800 (PST) In-Reply-To: <6E0A1C25FDBF47CC8ABE955745D42FB6@us.oracle.com> (Drew Adams's message of "Sun, 27 Jan 2013 22:26:13 -0800") User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/24.3.50 (gnu/linux) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.13 Precedence: list X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6.x X-Received-From: 140.186.70.43 X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Original-Sender: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.bugs:70396 Archived-At: "Drew Adams" 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... --