From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED!not-for-mail From: Drew Adams Newsgroups: gmane.emacs.bugs Subject: bug#25796: 24.5; doc string of `posn-at-point' Date: Sun, 19 Feb 2017 10:46:53 -0800 (PST) Message-ID: <1c0d2b8d-61f1-4505-b3ba-c53d97048eb4@default> NNTP-Posting-Host: blaine.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable X-Trace: blaine.gmane.org 1487530094 22489 195.159.176.226 (19 Feb 2017 18:48:14 GMT) X-Complaints-To: usenet@blaine.gmane.org NNTP-Posting-Date: Sun, 19 Feb 2017 18:48:14 +0000 (UTC) To: 25796@debbugs.gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Sun Feb 19 19:48:10 2017 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by blaine.gmane.org with esmtp (Exim 4.84_2) (envelope-from ) id 1cfWWl-0005Bp-9u for geb-bug-gnu-emacs@m.gmane.org; Sun, 19 Feb 2017 19:48:07 +0100 Original-Received: from localhost ([::1]:34767 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1cfWWp-0006ED-B0 for geb-bug-gnu-emacs@m.gmane.org; Sun, 19 Feb 2017 13:48:11 -0500 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:48626) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1cfWWj-0006E7-Uz for bug-gnu-emacs@gnu.org; Sun, 19 Feb 2017 13:48:06 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1cfWWg-0001Mo-Tj for bug-gnu-emacs@gnu.org; Sun, 19 Feb 2017 13:48:06 -0500 Original-Received: from debbugs.gnu.org ([208.118.235.43]:48257) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1cfWWg-0001Mi-Pl for bug-gnu-emacs@gnu.org; Sun, 19 Feb 2017 13:48:02 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1cfWWg-0003UC-GT for bug-gnu-emacs@gnu.org; Sun, 19 Feb 2017 13:48:02 -0500 X-Loop: help-debbugs@gnu.org Resent-From: Drew Adams Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sun, 19 Feb 2017 18:48:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 25796 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.148753003513337 (code B ref -1); Sun, 19 Feb 2017 18:48:02 +0000 Original-Received: (at submit) by debbugs.gnu.org; 19 Feb 2017 18:47:15 +0000 Original-Received: from localhost ([127.0.0.1]:46456 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1cfWVv-0003T3-MF for submit@debbugs.gnu.org; Sun, 19 Feb 2017 13:47:15 -0500 Original-Received: from eggs.gnu.org ([208.118.235.92]:57427) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1cfWVt-0003So-2i for submit@debbugs.gnu.org; Sun, 19 Feb 2017 13:47:13 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1cfWVn-0000pk-4b for submit@debbugs.gnu.org; Sun, 19 Feb 2017 13:47:07 -0500 Original-Received: from lists.gnu.org ([2001:4830:134:3::11]:46074) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1cfWVn-0000pa-1i for submit@debbugs.gnu.org; Sun, 19 Feb 2017 13:47:07 -0500 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:48397) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1cfWVl-0005z3-T6 for bug-gnu-emacs@gnu.org; Sun, 19 Feb 2017 13:47:06 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1cfWVi-0000oX-R6 for bug-gnu-emacs@gnu.org; Sun, 19 Feb 2017 13:47:05 -0500 Original-Received: from userp1040.oracle.com ([156.151.31.81]:50840) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1cfWVi-0000oJ-H9 for bug-gnu-emacs@gnu.org; Sun, 19 Feb 2017 13:47:02 -0500 Original-Received: from userv0021.oracle.com (userv0021.oracle.com [156.151.31.71]) by userp1040.oracle.com (Sentrion-MTA-4.3.2/Sentrion-MTA-4.3.2) with ESMTP id v1JIl0Nc021749 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK) for ; Sun, 19 Feb 2017 18:47:00 GMT Original-Received: from aserv0121.oracle.com (aserv0121.oracle.com [141.146.126.235]) by userv0021.oracle.com (8.14.4/8.14.4) with ESMTP id v1JIl0pk028315 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK) for ; Sun, 19 Feb 2017 18:47:00 GMT Original-Received: from abhmp0003.oracle.com (abhmp0003.oracle.com [141.146.116.9]) by aserv0121.oracle.com (8.13.8/8.13.8) with ESMTP id v1JIkvja007959 for ; Sun, 19 Feb 2017 18:46:58 GMT X-Priority: 3 X-Mailer: Oracle Beehive Extensions for Outlook 2.0.1.9.1 (1003210) [OL 12.0.6753.5000 (x86)] X-Source-IP: userv0021.oracle.com [156.151.31.71] X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.4.x-2.6.x [generic] [fuzzy] X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6.x X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 208.118.235.43 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.org@gnu.org Original-Sender: "bug-gnu-emacs" Xref: news.gmane.org gmane.emacs.bugs:129544 Archived-At: The first line of the doc string says this: "Return position information for buffer POS in WINDOW." That's unclear. "...for buffer XYZ..." is typically read to mean that XYZ is a buffer. Unless the parameter name itself can be clearly read as a word in the sentence, it is naturally interpreted as an appositive (a name) for "buffer". That's not the case for POS, but it would be the case for POSITION. Please rename the parameter POSITION, or find some other way to clarify this text. Further, the next occurrence of "position" in the doc string should also be written as POSITION (currently POS). In GNU Emacs 24.5.1 (i686-pc-mingw32) of 2015-04-11 on LEG570 Windowing system distributor `Microsoft Corp.', version 6.1.7601 Configured using: `configure --prefix=3D/c/usr --host=3Di686-pc-mingw32'