GNU bug report logs - #7136
Documentation: `completion-in-region-functions' punts to opacity

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 7136 in the body.
You can then email your comments to 7136 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: MON KEY <monkey <at> sandpframing.com>
To: bug-gnu-emacs <at> gnu.org
Subject: Documentation: `completion-in-region-functions' punts to opacity
Date: Wed, 29 Sep 2010 17:15:34 -0400

Docstring of variable `completion-in-region-functions' has this:

,----
| NEXT-FUN is a function of four arguments (START END COLLECTION PREDICATE)
| that performs the default operation.  The other four arguments are like
| the ones passed to `completion-in-region'.
`----

The punting in the second sentence above (e.g. "The other four") is
not helpful in the least.  The fourth arg PREDICATE is not documented
in `completion-in-region'.

Examining the source for `completion-in-region' one finds its first
evaluated form is a call to the `with-wrapper-hook' macro with
`completion-in-region-functions' as its first arg.

That `with-wrapper-hook' is itself recursive `labels' call with lexical
closures over its args renders the `completion-in-region-functions'
docstring completely opaque.

--
/s_P\

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

From: Lars Magne Ingebrigtsen <larsi <at> gnus.org>
To: MON KEY <monkey <at> sandpframing.com>
Cc: 7136 <at> debbugs.gnu.org
Subject: Re: bug#7136: Documentation: `completion-in-region-functions' punts
	to opacity
Date: Sat, 02 Jul 2011 18:08:11 +0200

MON KEY <monkey <at> sandpframing.com> writes:

> | NEXT-FUN is a function of four arguments (START END COLLECTION PREDICATE)
> | that performs the default operation.  The other four arguments are like
> | the ones passed to `completion-in-region'.
> `----
>
> The punting in the second sentence above (e.g. "The other four") is
> not helpful in the least.  The fourth arg PREDICATE is not documented
> in `completion-in-region'.

I've now documented that argument in `completion-in-region'.

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

Previous Next

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