From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: MON KEY Newsgroups: gmane.emacs.bugs Subject: bug#6788: Documentation: `delete-region' should explicity mention its parameters. Date: Tue, 3 Aug 2010 15:10:55 -0400 Message-ID: NNTP-Posting-Host: lo.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=UTF-8 X-Trace: dough.gmane.org 1280864299 5063 80.91.229.12 (3 Aug 2010 19:38:19 GMT) X-Complaints-To: usenet@dough.gmane.org NNTP-Posting-Date: Tue, 3 Aug 2010 19:38:19 +0000 (UTC) To: 6788@debbugs.gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Tue Aug 03 21:38:15 2010 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([199.232.76.165]) by lo.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1OgNJW-0006pv-Nf for geb-bug-gnu-emacs@m.gmane.org; Tue, 03 Aug 2010 21:38:15 +0200 Original-Received: from localhost ([127.0.0.1]:38793 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1OgNJV-000410-QN for geb-bug-gnu-emacs@m.gmane.org; Tue, 03 Aug 2010 15:38:13 -0400 Original-Received: from [140.186.70.92] (port=35035 helo=eggs.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1OgNJO-0003ze-1h for bug-gnu-emacs@gnu.org; Tue, 03 Aug 2010 15:38:07 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.69) (envelope-from ) id 1OgNJM-0000s6-N0 for bug-gnu-emacs@gnu.org; Tue, 03 Aug 2010 15:38:05 -0400 Original-Received: from debbugs.gnu.org ([140.186.70.43]:50536) by eggs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1OgNJM-0000rw-KW for bug-gnu-emacs@gnu.org; Tue, 03 Aug 2010 15:38:04 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.69) (envelope-from ) id 1OgMtB-0004BV-TE; Tue, 03 Aug 2010 15:11:01 -0400 X-Loop: help-debbugs@gnu.org 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: X-Debbugs-Original-To: bug-gnu-emacs@gnu.org Original-Received: via spool by submit@debbugs.gnu.org id=B.128086263416073 (code B ref -1); Tue, 03 Aug 2010 19:11:01 +0000 Original-Received: (at submit) by debbugs.gnu.org; 3 Aug 2010 19:10:34 +0000 Original-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 Original-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 Original-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 Original-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 Original-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 Original-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 Original-Received: by wwi14 with SMTP id 14so5242802wwi.30 for ; Tue, 03 Aug 2010 12:10:55 -0700 (PDT) Original-Received: by 10.227.157.147 with SMTP id b19mr6679107wbx.49.1280862655196; Tue, 03 Aug 2010 12:10:55 -0700 (PDT) Original-Received: by 10.216.49.84 with HTTP; Tue, 3 Aug 2010 12:10:55 -0700 (PDT) X-Google-Sender-Auth: MrLlWmBmuEcBroj8dq1fAPIDUy0 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-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.11 Precedence: list Resent-Date: Tue, 03 Aug 2010 15:11:01 -0400 X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6 (newer, 3) 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: , Original-Sender: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.bugs:39213 Archived-At: 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\