unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: Drew Adams <drew.adams@oracle.com>
Cc: 31790@debbugs.gnu.org
Subject: bug#31790: 27.0; Mention Isearch key bindings of Isedarch variables that are bound by	default in Isearch
Date: Sat, 16 Jun 2018 18:17:35 +0300	[thread overview]
Message-ID: <83in6izrow.fsf@gnu.org> (raw)
In-Reply-To: <9684bd5c-352c-4c83-9d05-e3d339f3e3d6@default> (message from Drew Adams on Sat, 16 Jun 2018 06:19:55 -0700 (PDT))

> Date: Sat, 16 Jun 2018 06:19:55 -0700 (PDT)
> From: Drew Adams <drew.adams@oracle.com>
> Cc: 31790@debbugs.gnu.org
> 
> > Those are variables, not defcustoms.  Why is it important to go to
> > such lengths in their doc strings?
> 
> Go to such lengths?  Really?
> 
> See https://emacs.stackexchange.com/q/41960/105.

I don't see how that is evidence to anything.

> Sure, if you consult the doc of `isearch-forward(-regexp)'
> or its keys, and you read it all, then when you get to line
> 43 (out of 82!) you'll find the info you're looking for wrt
> lax-vs-strict whitespace matching:

Those are powerful and flexible commands, it's no wonder their
documentation is long.  (And 82 lines is not too long in my book.)

> But if you don't do that then it is not so easy to pick
> up the info about that key binding.

And having that in a doc string of a non-user variable will make it
easier to pick up?

> Yes, we don't let those vars be options because of the
> Emacs policy that code should not modify option values
> (even the code for built-in toggles!).
> 
> It's an unfortunate policy, IMHO, but it is what it is.
> 
> It just makes sense to point out, in the doc for these
> two variables that, by default, `M-s SPC' toggles them
> while searching.

Like I said, I disagree.

Maybe we should provide defcustoms that would initialize the values of
these variables.  Then it would make sense to tell what you want in
those defcustoms' doc strings, like we do with search-invisible, for
example.





  reply	other threads:[~2018-06-16 15:17 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <<ef3d41cc-ef6d-4248-bfec-3fec23022762@default>
     [not found] ` <<83vaajynvp.fsf@gnu.org>
2018-06-16 13:19   ` bug#31790: 27.0; Mention Isearch key bindings of Isedarch variables that are bound by default in Isearch Drew Adams
2018-06-16 15:17     ` Eli Zaretskii [this message]
2018-06-16 22:57       ` Drew Adams
2018-06-11 22:16 Drew Adams
2018-06-16 11:25 ` Eli Zaretskii
2021-09-02  7:57 ` Lars Ingebrigtsen

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.gnu.org/software/emacs/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=83in6izrow.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=31790@debbugs.gnu.org \
    --cc=drew.adams@oracle.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
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).