From unknown Tue Sep 09 00:44:13 2025 X-Loop: help-debbugs@gnu.org Subject: bug#6788: Documentation: `delete-region' should explicity mention its parameters. Resent-From: MON KEY Original-Sender: debbugs-submit-bounces@debbugs.gnu.org Resent-To: owner@debbugs.gnu.org Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Tue, 03 Aug 2010 19:11:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 6788 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: To: 6788@debbugs.gnu.org X-Debbugs-Original-To: bug-gnu-emacs@gnu.org Received: via spool by submit@debbugs.gnu.org id=B.128086263416073 (code B ref -1); Tue, 03 Aug 2010 19:11:01 +0000 Received: (at submit) by debbugs.gnu.org; 3 Aug 2010 19:10:34 +0000 Received: from localhost ([127.0.0.1] helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1OgMsk-0004BC-5t for submit@debbugs.gnu.org; Tue, 03 Aug 2010 15:10:34 -0400 Received: from mail.gnu.org ([199.232.76.166] helo=mx10.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1OgMsi-0004B5-EI for submit@debbugs.gnu.org; Tue, 03 Aug 2010 15:10:33 -0400 Received: from lists.gnu.org ([199.232.76.165]:47817) by monty-python.gnu.org with esmtps (TLS-1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.60) (envelope-from ) id 1OgMt9-0003Fr-2S for submit@debbugs.gnu.org; Tue, 03 Aug 2010 15:10:59 -0400 Received: from [140.186.70.92] (port=42969 helo=eggs.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1OgMt7-0002za-NB for bug-gnu-emacs@gnu.org; Tue, 03 Aug 2010 15:10:58 -0400 X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on eggs.gnu.org X-Spam-Level: X-Spam-Status: No, score=-1.9 required=5.0 tests=BAYES_00 autolearn=unavailable version=3.3.1 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.69) (envelope-from ) id 1OgMt6-00046K-9G for bug-gnu-emacs@gnu.org; Tue, 03 Aug 2010 15:10:57 -0400 Received: from mail-ww0-f49.google.com ([74.125.82.49]:40133) by eggs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1OgMt6-000468-5D for bug-gnu-emacs@gnu.org; Tue, 03 Aug 2010 15:10:56 -0400 Received: by wwi14 with SMTP id 14so5242802wwi.30 for ; Tue, 03 Aug 2010 12:10:55 -0700 (PDT) MIME-Version: 1.0 Received: by 10.227.157.147 with SMTP id b19mr6679107wbx.49.1280862655196; Tue, 03 Aug 2010 12:10:55 -0700 (PDT) Received: by 10.216.49.84 with HTTP; Tue, 3 Aug 2010 12:10:55 -0700 (PDT) Date: Tue, 3 Aug 2010 15:10:55 -0400 X-Google-Sender-Auth: MrLlWmBmuEcBroj8dq1fAPIDUy0 Message-ID: From: MON KEY Content-Type: text/plain; charset=UTF-8 X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6 (newer, 2) X-detected-operating-system: by monty-python.gnu.org: GNU/Linux 2.6, seldom 2.4 (older, 4) X-Spam-Score: -3.9 (---) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.11 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: debbugs-submit-bounces@debbugs.gnu.org Errors-To: debbugs-submit-bounces@debbugs.gnu.org X-Spam-Score: -5.2 (-----) Documentation: `delete-region' should explicitly mention its parameters. ,---- (documentation 'delete-region) | | Delete the text between point and mark. | | When called from a program, expects two arguments, | positions (integers or markers) specifying the stretch to be deleted. | `---- `delete-region' can be called-interactively and exists on the menu-bar: (where-is 'delete-region t) => (delete-region) But doesn't have a default global key-binding (at least w/ Emacs 23.2). While it is reasonable that the docs indicate the _command_ will: "Delete the text between point and mark." The docstring should also explicitly mention the parameters elsewhere as delete region can be called programmatically (and probably more often so than from user input). The following portion: "When called from a program, expects two arguments, positions (integers or markers) specifying the stretch to be deleted." Would be better stated as: "When called from a program, the arguments START and END are buffer positions (integers or markers) specifying a region to delete." Additionally, to the extent with which this function is presented as a user command i.e. as indicated by it's accessibility from the menu-bar and by the docstring's opening phraseology; I would propose that some indication be given that the delete-region _command_ does not alter the kill-ring in a like manner as the `kill-region' command by stating: "Delete the text between point and mark. This command deletes buffer text without modifying the kill ring." Providing such an indication would be in keeping with the current docstring of `kill-region's second sentence: "Kill ("cut") text between point and mark. This deletes the text from the buffer and saves it in the kill ring." -- /s_P\ From debbugs-submit-bounces@debbugs.gnu.org Thu Jul 14 09:41:37 2011 Received: (at control) by debbugs.gnu.org; 14 Jul 2011 13:41:38 +0000 Received: from localhost ([127.0.0.1] helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1QhMAb-0001SF-Fs for submit@debbugs.gnu.org; Thu, 14 Jul 2011 09:41:37 -0400 Received: from hermes.netfonds.no ([80.91.224.195]) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1QhMAZ-0001Rz-LU for control@debbugs.gnu.org; Thu, 14 Jul 2011 09:41:36 -0400 Received: from cm-84.215.51.58.getinternet.no ([84.215.51.58] helo=quimbies.gnus.org) by hermes.netfonds.no with esmtpsa (TLS1.0:DHE_RSA_AES_128_CBC_SHA1:16) (Exim 4.72) (envelope-from ) id 1QhMAN-0006W5-T2 for control@debbugs.gnu.org; Thu, 14 Jul 2011 15:41:23 +0200 Date: Thu, 14 Jul 2011 15:41:23 +0200 Message-Id: To: control@debbugs.gnu.org From: Lars Magne Ingebrigtsen Subject: control message for bug #6788 X-MailScanner-ID: 1QhMAN-0006W5-T2 X-Netfonds-MailScanner: Found to be clean X-Netfonds-MailScanner-From: larsi@gnus.org MailScanner-NULL-Check: 1311255684.09356@tGR3Fr+2eUtuFaeDUKRIig X-Spam-Status: No X-Spam-Score: -2.7 (--) X-Debbugs-Envelope-To: control X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.11 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: debbugs-submit-bounces@debbugs.gnu.org Errors-To: debbugs-submit-bounces@debbugs.gnu.org X-Spam-Score: -2.7 (--) tags 6788 fixed close 6788 24.1 From unknown Tue Sep 09 00:44:13 2025 X-Loop: help-debbugs@gnu.org Subject: bug#6788: Documentation: `delete-region' should explicity mention its parameters. Resent-From: Lars Magne Ingebrigtsen Original-Sender: debbugs-submit-bounces@debbugs.gnu.org Resent-To: owner@debbugs.gnu.org Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Thu, 14 Jul 2011 14:03:06 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 6788 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: fixed To: MON KEY Cc: 6788@debbugs.gnu.org Received: via spool by 6788-submit@debbugs.gnu.org id=B6788.131065217915566 (code B ref 6788); Thu, 14 Jul 2011 14:03:06 +0000 Received: (at 6788) by debbugs.gnu.org; 14 Jul 2011 14:02:59 +0000 Received: from localhost ([127.0.0.1] helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1QhMVD-00042q-H0 for submit@debbugs.gnu.org; Thu, 14 Jul 2011 10:02:59 -0400 Received: from hermes.netfonds.no ([80.91.224.195]) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1QhMUl-00040x-OV for 6788@debbugs.gnu.org; Thu, 14 Jul 2011 10:02:34 -0400 Received: from cm-84.215.51.58.getinternet.no ([84.215.51.58] helo=quimbies.gnus.org) by hermes.netfonds.no with esmtpsa (TLS1.0:DHE_RSA_AES_128_CBC_SHA1:16) (Exim 4.72) (envelope-from ) id 1QhMUW-00072E-Hu; Thu, 14 Jul 2011 16:02:12 +0200 From: Lars Magne Ingebrigtsen In-Reply-To: (MON KEY's message of "Tue, 3 Aug 2010 15:10:55 -0400") Date: Thu, 14 Jul 2011 15:41:20 +0200 Message-ID: References: User-Agent: Gnus/5.110018 (No Gnus v0.18) Emacs/24.0.50 (gnu/linux) X-Now-Playing: Depeche Mode's _Some Great Reward_: "Something To Do" X-Hashcash: 1:23:110714:monkey@sandpframing.com::TstbHKTUmkdyucaC:000000000000000000000000000000000000008CIu X-Hashcash: 1:23:110714:6788@debbugs.gnu.org::DjjT/qcVycIUUbss:00000000000000000000000000000000000000000deU6 MIME-Version: 1.0 Content-Type: text/plain X-MailScanner-ID: 1QhMUW-00072E-Hu X-Netfonds-MailScanner: Found to be clean X-Netfonds-MailScanner-From: larsi@gnus.org MailScanner-NULL-Check: 1311256932.74403@2qU56ty7T8rkJWJBS3o5Eg X-Spam-Status: No X-Spam-Score: -2.7 (--) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.11 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: debbugs-submit-bounces@debbugs.gnu.org Errors-To: debbugs-submit-bounces@debbugs.gnu.org X-Spam-Score: -2.7 (--) MON KEY writes: > While it is reasonable that the docs indicate the _command_ will: > > "Delete the text between point and mark." > > The docstring should also explicitly mention the parameters elsewhere > as delete region can be called programmatically (and probably more > often so than from user input). The following portion: > > "When called from a program, expects two arguments, positions > (integers or markers) specifying the stretch to be deleted." I've now clarified the doc string in Emacs 24. -- (domestic pets only, the antidote for overdose, milk.) bloggy blog http://lars.ingebrigtsen.no/