From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.bugs Subject: bug#55050: 27.2; Doc strings for commands that do query-replacements Date: Thu, 21 Apr 2022 15:03:24 +0300 Message-ID: <83v8v2r6cz.fsf@gnu.org> References: Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="15957"; mail-complaints-to="usenet@ciao.gmane.io" Cc: 55050-done@debbugs.gnu.org To: Drew Adams Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Thu Apr 21 14:13:41 2022 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1nhVgr-0003z5-7T for geb-bug-gnu-emacs@m.gmane-mx.org; Thu, 21 Apr 2022 14:13:41 +0200 Original-Received: from localhost ([::1]:56360 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1nhVgq-0002V7-64 for geb-bug-gnu-emacs@m.gmane-mx.org; Thu, 21 Apr 2022 08:13:40 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:39958) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nhVXW-00059q-5z for bug-gnu-emacs@gnu.org; Thu, 21 Apr 2022 08:04:03 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]:54709) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1nhVXV-0002Zg-SI for bug-gnu-emacs@gnu.org; Thu, 21 Apr 2022 08:04:01 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1nhVXV-0006h0-KW for bug-gnu-emacs@gnu.org; Thu, 21 Apr 2022 08:04:01 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Eli Zaretskii Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Thu, 21 Apr 2022 12:04:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 55050 X-GNU-PR-Package: emacs Original-Received: via spool by 55050-done@debbugs.gnu.org id=D55050.165054261925690 (code D ref 55050); Thu, 21 Apr 2022 12:04:01 +0000 Original-Received: (at 55050-done) by debbugs.gnu.org; 21 Apr 2022 12:03:39 +0000 Original-Received: from localhost ([127.0.0.1]:48606 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1nhVX8-0006gI-Rv for submit@debbugs.gnu.org; Thu, 21 Apr 2022 08:03:39 -0400 Original-Received: from eggs.gnu.org ([209.51.188.92]:46604) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1nhVX6-0006g2-A9 for 55050-done@debbugs.gnu.org; Thu, 21 Apr 2022 08:03:37 -0400 Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]:58964) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nhVX1-0002Vg-1s; Thu, 21 Apr 2022 08:03:31 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org; s=fencepost-gnu-org; h=References:Subject:In-Reply-To:To:From:Date: mime-version; bh=fyrH2tRDRs78mcvbYfBmcajs61G4+fX/6OEcKRUsDUU=; b=Np/8QDotENNn 7+yhB30LORit6AtGGJVz/AS0DLVkaqr0jEqpx5ZYxpMw56ZxO21QFLbKNJ3AZfEmwfJcRu4P8QGaG BCtWQWJkECS0qDwnppHSSgwdTEWR8ih48q+o2Lk/zrrB72p5SKanX8eHW932vr2fuTV24KE2uW1ja ZO+bNJjeHGkvuBlXSbMJ36jNghxuZ+rY4lA6ytOT9sga2MWFWy8TJ2GIDSLN9Pl0W+Z9BUftmJpJw hY38X9hHzyeAllwBK8/+5j1CPpD0m74rs87Wh6hM4s373NQOqxxcRUa9FiZ9XKx4QY3wasK+ucPWq V65Y0HiUvfFEp9MG4VQhtw==; Original-Received: from [87.69.77.57] (port=4355 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nhVWz-00085I-EV; Thu, 21 Apr 2022 08:03:30 -0400 In-Reply-To: (message from Drew Adams on Thu, 21 Apr 2022 02:46:16 +0000) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Original-Sender: "bug-gnu-emacs" Xref: news.gmane.io gmane.emacs.bugs:230354 Archived-At: > From: Drew Adams > Date: Thu, 21 Apr 2022 02:46:16 +0000 > > This is about the doc of commands, such as > `dired-do-find-regexp-and-replace', that use a query-replace dialog. > There are a bunch of such commands now. For the most part, they don't > tell you anything about what to expect, in terms of a dialog. In > particular, they don't reference the doc of `query-replace`, which is > (at least) where the dialog should be described. > > The only saving grace is that there's a prompt that suggests that if you > hit `?' you might get some information about what you can do. Assuming > you notice that prompt, of course. If you don't assume they pay attention to the prompt, why assume they will read the doc string, which is much longer and whose instructions it is therefore much easier to miss? > The doc of all such commands should, directly or indirectly, tell you > about the keys you can use and what they do - what you learn by hitting > `?'. It is not reasonable to show all the commands available for dealing with matches: the list is very long, and will make the doc strings unbearably long, especially for people who are interested in other aspects of these commands than how to deal with matches. So I added the minimal instructions to all the commands I found which perform query-replace of some sort: how to accept a replacement and how to skip it -- with a reference to 'h' that will show the full instructions. This, of course, is _in_addition_ to the already existing link to 'query-replace'/'query-replace-regexp', which in itself is a reference to that stuff. > See, for example, this user's question: > > https://emacs.stackexchange.com/q/71451/105 FTR, that question has nothing to do with the subject of this bug report, it is about the user's confusion with the fact that Emacs doesn't let users modify write-protected files, and what to do when the user wants to modify such files even though they are read-only.