unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
* bug#14731: 24.3.50; doc string of `search-invisible'
@ 2013-06-27 14:52 Drew Adams
  2013-06-27 17:08 ` Stefan Monnier
  0 siblings, 1 reply; 6+ messages in thread
From: Drew Adams @ 2013-06-27 14:52 UTC (permalink / raw)
  To: 14731

The first line should say "non-nil" instead of "t":

"If t incremental search can match hidden text."

In GNU Emacs 24.3.50.1 (i686-pc-mingw32)
 of 2013-06-20 on ODIEONE
Bzr revision: 113100 eliz@gnu.org-20130620173624-w9v620tog4yacftk
Windowing system distributor `Microsoft Corp.', version 6.1.7601
Configured using:
 `configure --prefix=/c/Devel/emacs/binary --enable-checking=yes,glyphs
 CFLAGS=-O0 -g3 LDFLAGS=-Lc:/Devel/emacs/lib
 CPPFLAGS=-Ic:/Devel/emacs/include'





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

* bug#14731: 24.3.50; doc string of `search-invisible'
  2013-06-27 14:52 bug#14731: 24.3.50; doc string of `search-invisible' Drew Adams
@ 2013-06-27 17:08 ` Stefan Monnier
  2013-06-27 17:31   ` Drew Adams
  0 siblings, 1 reply; 6+ messages in thread
From: Stefan Monnier @ 2013-06-27 17:08 UTC (permalink / raw)
  To: Drew Adams; +Cc: 14731-done

> "If t incremental search can match hidden text."

I don't see any reason why non-nil would be better.
People using non-nil non-t values are on their own,


        Stefan





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

* bug#14731: 24.3.50; doc string of `search-invisible'
  2013-06-27 17:08 ` Stefan Monnier
@ 2013-06-27 17:31   ` Drew Adams
  2013-06-27 18:16     ` Stefan Monnier
  0 siblings, 1 reply; 6+ messages in thread
From: Drew Adams @ 2013-06-27 17:31 UTC (permalink / raw)
  To: Stefan Monnier; +Cc: 14731-done

> > "If t incremental search can match hidden text."
> 
> I don't see any reason why non-nil would be better.
> People using non-nil non-t values are on their own,

Huh?  Did you read the rest of the doc string, which mentions
`open'?  The first line of the doc string should stand on its own.

There are specifically three useful values: nil, t, and `open'.
t and `open' do not behave the same.  And those are the 3 values of
user option `search-invisible'.  `open' is hardly something hidden
from users - they are not "on their own" with `open'.

If you prefer, then say "If nil then incremental search does not
match hidden text."

That is also more correct, because it does not promise more than
is delivered.  `open' does NOT cause isearch to match text that is
hidden using a text property (`invisible').  `open' works only for
only certain kinds of hidden text (from specific kinds of overlays,
not from text properties).

Yes, you can hide behind the ambiguity of the words "CAN match",
but it is clearer to say that nil means isearch does not match
hidden text.

(BTW, this fact is undocumented: t does cause isearch to match such
hidden occurrences.  Unlike `open', t does not require that the text
be hidden using an overlay.)





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

* bug#14731: 24.3.50; doc string of `search-invisible'
  2013-06-27 17:31   ` Drew Adams
@ 2013-06-27 18:16     ` Stefan Monnier
  2013-06-27 20:18       ` Drew Adams
  0 siblings, 1 reply; 6+ messages in thread
From: Stefan Monnier @ 2013-06-27 18:16 UTC (permalink / raw)
  To: Drew Adams; +Cc: 14731-done

> The first line of the doc string should stand on its own.

That doesn't mean it should be complete.


        Stefan





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

* bug#14731: 24.3.50; doc string of `search-invisible'
  2013-06-27 18:16     ` Stefan Monnier
@ 2013-06-27 20:18       ` Drew Adams
  2013-06-27 23:13         ` Stefan Monnier
  0 siblings, 1 reply; 6+ messages in thread
From: Drew Adams @ 2013-06-27 20:18 UTC (permalink / raw)
  To: Stefan Monnier; +Cc: 14731-done

> That doesn't mean it should be complete.

No reason to mislead needlessly.

Not to mention that the *default* value is non-t and non-nil.

(That is, it is a value for which users should be on their own
according to your first argument.)





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

* bug#14731: 24.3.50; doc string of `search-invisible'
  2013-06-27 20:18       ` Drew Adams
@ 2013-06-27 23:13         ` Stefan Monnier
  0 siblings, 0 replies; 6+ messages in thread
From: Stefan Monnier @ 2013-06-27 23:13 UTC (permalink / raw)
  To: Drew Adams; +Cc: 14731-done

>> That doesn't mean it should be complete.
> No reason to mislead needlessly.
> Not to mention that the *default* value is non-t and non-nil.

Feel free to install a corresponding patch.


        Stefan





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

end of thread, other threads:[~2013-06-27 23:13 UTC | newest]

Thread overview: 6+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2013-06-27 14:52 bug#14731: 24.3.50; doc string of `search-invisible' Drew Adams
2013-06-27 17:08 ` Stefan Monnier
2013-06-27 17:31   ` Drew Adams
2013-06-27 18:16     ` Stefan Monnier
2013-06-27 20:18       ` Drew Adams
2013-06-27 23:13         ` Stefan Monnier

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