GNU bug report logs - #64045
[PATCH] Improve wording of the documentation about declare form

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 64045 in the body.
You can then email your comments to 64045 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: Shynur Xie <one.last.kiss <at> outlook.com>
To: "bug-gnu-emacs <at> gnu.org" <bug-gnu-emacs <at> gnu.org>
Subject: [PATCH] Improve wording of the documentation about declare form
Date: Tue, 13 Jun 2023 13:36:50 +0000

[Message part 1 (text/plain, inline)]

I modified section 13.14 (The declare form) of the GNU Emacs Lisp
Reference Manual.  The manual didn't say how to make

    (declare (completion ...)
             (modes ...))

take effect; the original text is even somewhat misleading.  Simply
evaluating a (defun ...) form which includes the above declare form
won't make Emacs filter commands when asking for completion in M-x.

--
shynur

[0001-Improve-wording-of-the-documentation-about-declare-f.patch (application/octet-stream, attachment)]

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Shynur Xie <one.last.kiss <at> outlook.com>
Cc: 64045 <at> debbugs.gnu.org
Subject: Re: bug#64045: [PATCH] Improve wording of the documentation about
 declare form
Date: Tue, 13 Jun 2023 16:46:47 +0300

> From: Shynur Xie <one.last.kiss <at> outlook.com>
> Date: Tue, 13 Jun 2023 13:36:50 +0000
> msip_labels: 
> 
> I modified section 13.14 (The declare form) of the GNU Emacs Lisp
> Reference Manual.  The manual didn't say how to make
> 
>     (declare (completion ...)
>              (modes ...))
> 
> take effect; the original text is even somewhat misleading.  Simply
> evaluating a (defun ...) form which includes the above declare form
> won't make Emacs filter commands when asking for completion in M-x.

Thanks, but the text you suggest reads as more complex and harder to
understand.  So how about explaining what was wrong or missing or
unclear in the original text?  Then I could come up with a better
wording.

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

From: Shynur Xie <one.last.kiss <at> outlook.com>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: "64045 <at> debbugs.gnu.org" <64045 <at> debbugs.gnu.org>
Subject: Re: bug#64045: [PATCH] Improve wording of the documentation about
 declare form
Date: Tue, 13 Jun 2023 13:54:26 +0000

>    From: Eli Zaretskii <eliz <at> gnu.org>
>    Date: Tue, 13 Jun 2023 16:46:47 +0300
> Subject: Re: bug#64045
>      To: Shynur Xie <one.last.kiss <at> outlook.com>
>
> So how about explaining what was wrong or missing or unclear in the
> original text?

You can read these 2 posts (very short and won't take up much of your
time):

- Question: Effect of `modes` In Declare Form
  https://emacs.stackexchange.com/questions/77597
- Question: `completion` In Declare Form Not Working
  https://emacs.stackexchange.com/questions/77599

Thanks.

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Shynur Xie <one.last.kiss <at> outlook.com>
Cc: 64045 <at> debbugs.gnu.org
Subject: Re: bug#64045: [PATCH] Improve wording of the documentation about
 declare form
Date: Thu, 15 Jun 2023 09:29:48 +0300

> From: Shynur Xie <one.last.kiss <at> outlook.com>
> CC: "64045 <at> debbugs.gnu.org" <64045 <at> debbugs.gnu.org>
> Date: Tue, 13 Jun 2023 13:54:26 +0000
> msip_labels:
> 
> >    From: Eli Zaretskii <eliz <at> gnu.org>
> >    Date: Tue, 13 Jun 2023 16:46:47 +0300
> > Subject: Re: bug#64045
> >      To: Shynur Xie <one.last.kiss <at> outlook.com>
> >
> > So how about explaining what was wrong or missing or unclear in the
> > original text?
> 
> You can read these 2 posts (very short and won't take up much of your
> time):
> 
> - Question: Effect of `modes` In Declare Form
>   https://emacs.stackexchange.com/questions/77597
> - Question: `completion` In Declare Form Not Working
>   https://emacs.stackexchange.com/questions/77599

Thanks, I've clarified these now on the emacs-29 branch.

Message #19 received at 64045-done <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: one.last.kiss <at> outlook.com
Cc: 64045-done <at> debbugs.gnu.org
Subject: Re: bug#64045: [PATCH] Improve wording of the documentation about
 declare form
Date: Wed, 21 Jun 2023 17:07:28 +0300

> Cc: 64045 <at> debbugs.gnu.org
> Date: Thu, 15 Jun 2023 09:29:48 +0300
> From: Eli Zaretskii <eliz <at> gnu.org>
> 
> > From: Shynur Xie <one.last.kiss <at> outlook.com>
> > CC: "64045 <at> debbugs.gnu.org" <64045 <at> debbugs.gnu.org>
> > Date: Tue, 13 Jun 2023 13:54:26 +0000
> > msip_labels:
> > 
> > >    From: Eli Zaretskii <eliz <at> gnu.org>
> > >    Date: Tue, 13 Jun 2023 16:46:47 +0300
> > > Subject: Re: bug#64045
> > >      To: Shynur Xie <one.last.kiss <at> outlook.com>
> > >
> > > So how about explaining what was wrong or missing or unclear in the
> > > original text?
> > 
> > You can read these 2 posts (very short and won't take up much of your
> > time):
> > 
> > - Question: Effect of `modes` In Declare Form
> >   https://emacs.stackexchange.com/questions/77597
> > - Question: `completion` In Declare Form Not Working
> >   https://emacs.stackexchange.com/questions/77599
> 
> Thanks, I've clarified these now on the emacs-29 branch.

No further comments, so I'm now closing this bug.

Previous Next

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