unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
* bug#14006: 24.3.50; doc of `completion-in-region-mode', `completion-in-region'
@ 2013-03-20 14:44 Drew Adams
  2014-02-10  7:00 ` Lars Ingebrigtsen
  2021-07-15  6:28 ` Lars Ingebrigtsen
  0 siblings, 2 replies; 4+ messages in thread
From: Drew Adams @ 2013-03-20 14:44 UTC (permalink / raw)
  To: 14006

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@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'
 






^ permalink raw reply	[flat|nested] 4+ messages in thread

* bug#14006: 24.3.50; doc of `completion-in-region-mode', `completion-in-region'
  2013-03-20 14:44 bug#14006: 24.3.50; doc of `completion-in-region-mode', `completion-in-region' Drew Adams
@ 2014-02-10  7:00 ` Lars Ingebrigtsen
  2014-02-10 17:29   ` Drew Adams
  2021-07-15  6:28 ` Lars Ingebrigtsen
  1 sibling, 1 reply; 4+ messages in thread
From: Lars Ingebrigtsen @ 2014-02-10  7:00 UTC (permalink / raw)
  To: Drew Adams; +Cc: 14006

"Drew Adams" <drew.adams@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/





^ permalink raw reply	[flat|nested] 4+ messages in thread

* bug#14006: 24.3.50; doc of `completion-in-region-mode', `completion-in-region'
  2014-02-10  7:00 ` Lars Ingebrigtsen
@ 2014-02-10 17:29   ` Drew Adams
  0 siblings, 0 replies; 4+ messages in thread
From: Drew Adams @ 2014-02-10 17:29 UTC (permalink / raw)
  To: Lars Ingebrigtsen; +Cc: 14006

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

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





^ permalink raw reply	[flat|nested] 4+ messages in thread

* bug#14006: 24.3.50; doc of `completion-in-region-mode', `completion-in-region'
  2013-03-20 14:44 bug#14006: 24.3.50; doc of `completion-in-region-mode', `completion-in-region' Drew Adams
  2014-02-10  7:00 ` Lars Ingebrigtsen
@ 2021-07-15  6:28 ` Lars Ingebrigtsen
  1 sibling, 0 replies; 4+ messages in thread
From: Lars Ingebrigtsen @ 2021-07-15  6:28 UTC (permalink / raw)
  To: Drew Adams; +Cc: 14006

"Drew Adams" <drew.adams@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





^ permalink raw reply	[flat|nested] 4+ messages in thread

end of thread, other threads:[~2021-07-15  6:28 UTC | newest]

Thread overview: 4+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2013-03-20 14:44 bug#14006: 24.3.50; doc of `completion-in-region-mode', `completion-in-region' Drew Adams
2014-02-10  7:00 ` Lars Ingebrigtsen
2014-02-10 17:29   ` Drew Adams
2021-07-15  6:28 ` Lars Ingebrigtsen

Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).