GNU bug report logs - #14006
24.3.50; doc of `completion-in-region-mode', `completion-in-region'

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 14006 in the body.
You can then email your comments to 14006 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.3.50; doc of `completion-in-region-mode', `completion-in-region'
Date: Wed, 20 Mar 2013 07:44:20 -0700

Doc string of `completion-in-region-mode' is useless.  It says nothing
more than that the mode is "used during `completion-in-region'.  Used
for what?  Used how?  What does it do?  (And there is a typo presumably:
"modemode".  It doesn't seem like much thought or time was expended on
this doc.
 
Doc string of `completion-in-region' does not say how PREDICATE is used
- what it means to "say when to exit" (how? why? exit what?).  And it
is not clear whether point can be START or END or both or neither:
"between" generally excludes both end points, but the meaning should
be made explicit.  And nothing is said about what COLLECTION is -
"using COLLECTION" means nothing.  At least cross-ref some other doc
that describes COLLECTION.
 
(elisp) `Completion in Buffers' says little more than what the doc
string of `completion-in-region' says.  (At least it cross-references 
COLLECTION.)  And it says nothing about `completion-in-region-mode'.
 
In GNU Emacs 24.3.50.1 (i386-mingw-nt5.1.2600)
 of 2013-03-17 on ODIEONE
Bzr revision: 112068 michael.albinus <at> gmx.de-20130317173046-sgy1bmmkkizorqby
Windowing system distributor `Microsoft Corp.', version 5.1.2600
Configured using:
 `configure --with-gcc (4.7) --no-opt --enable-checking --cflags
 -IC:/Devel/emacs/build/include --ldflags -LC:/Devel/emacs/build/lib'
 

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

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: "Drew Adams" <drew.adams <at> oracle.com>
Cc: 14006 <at> debbugs.gnu.org
Subject: Re: bug#14006: 24.3.50;
 doc of `completion-in-region-mode', `completion-in-region'
Date: Sun, 09 Feb 2014 23:00:37 -0800

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

> Doc string of `completion-in-region-mode' is useless.  It says nothing
> more than that the mode is "used during `completion-in-region'.  Used
> for what?  Used how?  What does it do?  (And there is a typo presumably:
> "modemode".  It doesn't seem like much thought or time was expended on
> this doc.

I don't see the "modemode"...

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

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

From: Drew Adams <drew.adams <at> oracle.com>
To: Lars Ingebrigtsen <larsi <at> gnus.org>
Cc: 14006 <at> debbugs.gnu.org
Subject: RE: bug#14006: 24.3.50; doc of `completion-in-region-mode',
 `completion-in-region'
Date: Mon, 10 Feb 2014 09:29:47 -0800 (PST)

> I don't see the "modemode"...

That typo was apparently fixed.  But the bug was not.

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

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: "Drew Adams" <drew.adams <at> oracle.com>
Cc: 14006 <at> debbugs.gnu.org
Subject: Re: bug#14006: 24.3.50; doc of `completion-in-region-mode',
 `completion-in-region'
Date: Thu, 15 Jul 2021 08:28:15 +0200

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

> Doc string of `completion-in-region-mode' is useless.  It says nothing
> more than that the mode is "used during `completion-in-region'.  Used
> for what?  Used how?  What does it do?

I think that's beyond the role of the doc string here for this
internalish mode.

> Doc string of `completion-in-region' does not say how PREDICATE is used
> - what it means to "say when to exit" (how? why? exit what?).  And it
> is not clear whether point can be START or END or both or neither:
> "between" generally excludes both end points, but the meaning should
> be made explicit.  And nothing is said about what COLLECTION is -
> "using COLLECTION" means nothing.  At least cross-ref some other doc
> that describes COLLECTION.
>
> (elisp) `Completion in Buffers' says little more than what the doc
> string of `completion-in-region' says.  (At least it cross-references 
> COLLECTION.)  And it says nothing about `completion-in-region-mode'.

I think the doc string here is good enough, and punting to the manual
for more talk is fine.  Closing.

-- 
(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.