GNU bug report logs - #9668
24.0.50; doc of `declare' (non-CL version)

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 9668 in the body.
You can then email your comments to 9668 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: "Drew Adams" <drew.adams <at> oracle.com>
To: <bug-gnu-emacs <at> gnu.org>
Subject: 24.0.50; doc of `declare' (non-CL version)
Date: Tue, 4 Oct 2011 09:23:42 -0700

`(elisp) Defining Macros says' that `declare' works only for `debug' and
`indent'.  But the Emacs Lisp source code has lots of occurrences of
`doc-string', and `ignore' as well.  Seems like the doc is not
up-to-date?  (I'm not counting occurrences of CL's `declare special'.)
 
(And the `declare' doc string just refers to the manual - does not
describe the SPECS that it mentions at all.  That's probably OK.)
 

In GNU Emacs 24.0.50.1 (i386-mingw-nt5.1.2600)
 of 2011-09-19 on 3249CTO
Windowing system distributor `Microsoft Corp.', version 5.1.2600
configured using `configure --with-gcc (4.5) --no-opt'
 

Message #8 received at 9668 <at> debbugs.gnu.org (full text, mbox):

From: Lars Magne Ingebrigtsen <larsi <at> gnus.org>
To: "Drew Adams" <drew.adams <at> oracle.com>
Cc: 9668 <at> debbugs.gnu.org
Subject: Re: bug#9668: 24.0.50; doc of `declare' (non-CL version)
Date: Sat, 07 Jan 2012 06:48:33 +0100

"Drew Adams" <drew.adams <at> oracle.com> writes:

> `(elisp) Defining Macros says' that `declare' works only for `debug' and
> `indent'.  But the Emacs Lisp source code has lots of occurrences of
> `doc-string', and `ignore' as well.  Seems like the doc is not
> up-to-date?  (I'm not counting occurrences of CL's `declare special'.)

The only instances of `ignore' I could find weren't in `defmacro' forms,
which probably means that it has no effect whatsoever.

But I've now added `doc-string' to the manual.

-- 
(domestic pets only, the antidote for overdose, milk.)
  bloggy blog http://lars.ingebrigtsen.no/

Message #15 received at 9668 <at> debbugs.gnu.org (full text, mbox):

From: "Drew Adams" <drew.adams <at> oracle.com>
To: "'Lars Magne Ingebrigtsen'" <larsi <at> gnus.org>
Cc: 9668 <at> debbugs.gnu.org
Subject: RE: bug#9668: 24.0.50; doc of `declare' (non-CL version)
Date: Sat, 7 Jan 2012 07:35:09 -0800

> The only instances of `ignore' I could find weren't in 
> `defmacro' forms, which probably means that it has no effect whatsoever.
> 
> But I've now added `doc-string' to the manual.

Thanks.  I don't have your fix in front of me.  Hope you also corrected the last
sentence of the node: "It only affects secondary features: indentation and
Edebug."

Message #18 received at 9668 <at> debbugs.gnu.org (full text, mbox):

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: "Drew Adams" <drew.adams <at> oracle.com>
Cc: 9668 <at> debbugs.gnu.org
Subject: Re: bug#9668: 24.0.50; doc of `declare' (non-CL version)
Date: Thu, 26 Jan 2012 00:58:46 +0100

"Drew Adams" <drew.adams <at> oracle.com> writes:

> Thanks.  I don't have your fix in front of me.  Hope you also
> corrected the last sentence of the node: "It only affects secondary
> features: indentation and Edebug."

No, because I didn't think that was wrong.  Does `doc-string' do
anything other than alter the indentation of the doc string?

Hm...  I guess `autoload' also uses it.  I'll fix up that paragraph,
too.

-- 
(domestic pets only, the antidote for overdose, milk.)
  http://lars.ingebrigtsen.no  *  Sent from my Rome

Message #21 received at 9668 <at> debbugs.gnu.org (full text, mbox):

From: "Drew Adams" <drew.adams <at> oracle.com>
To: "'Lars Ingebrigtsen'" <larsi <at> gnus.org>
Cc: 9668 <at> debbugs.gnu.org
Subject: RE: bug#9668: 24.0.50; doc of `declare' (non-CL version)
Date: Wed, 25 Jan 2012 16:22:36 -0800

> > Thanks.  I don't have your fix in front of me.  Hope you also
> > corrected the last sentence of the node: "It only affects secondary
> > features: indentation and Edebug."
> 
> No, because I didn't think that was wrong.  Does `doc-string' do
> anything other than alter the indentation of the doc string?
> 
> Hm...  I guess `autoload' also uses it.  I'll fix up that paragraph,
> too.

Huh?  It's not about what `doc-string' affects.  It's about what `declare'
affects.

The sentence says that `declare' is only for `indent' and `debug', but it is
also for `doc-string'.  That's the point.

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.