From unknown Wed Sep 10 16:41:27 2025 Content-Disposition: inline Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 X-Mailer: MIME-tools 5.509 (Entity 5.509) Content-Type: text/plain; charset=utf-8 From: bug#6958 <6958@debbugs.gnu.org> To: bug#6958 <6958@debbugs.gnu.org> Subject: Status: Documentation: `posn-actual-col-row' is unclear Reply-To: bug#6958 <6958@debbugs.gnu.org> Date: Wed, 10 Sep 2025 23:41:27 +0000 retitle 6958 Documentation: `posn-actual-col-row' is unclear reassign 6958 emacs submitter 6958 MON KEY severity 6958 minor tag 6958 notabug thanks From debbugs-submit-bounces@debbugs.gnu.org Tue Aug 31 16:57:04 2010 Received: (at submit) by debbugs.gnu.org; 31 Aug 2010 20:57:04 +0000 Received: from localhost ([127.0.0.1] helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1OqXt9-0002dz-0z for submit@debbugs.gnu.org; Tue, 31 Aug 2010 16:57:03 -0400 Received: from mx10.gnu.org ([199.232.76.166]) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1OqXt6-0002db-Ly for submit@debbugs.gnu.org; Tue, 31 Aug 2010 16:57:01 -0400 Received: from lists.gnu.org ([199.232.76.165]:36105) by monty-python.gnu.org with esmtps (TLS-1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.60) (envelope-from ) id 1OqXuh-0007CD-IX for submit@debbugs.gnu.org; Tue, 31 Aug 2010 16:58:39 -0400 Received: from [140.186.70.92] (port=35366 helo=eggs.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1OqXug-0000mU-5q for bug-gnu-emacs@gnu.org; Tue, 31 Aug 2010 16:58:39 -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,RCVD_IN_DNSWL_NONE autolearn=unavailable version=3.3.1 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.69) (envelope-from ) id 1OqXue-0006WH-Uo for bug-gnu-emacs@gnu.org; Tue, 31 Aug 2010 16:58:38 -0400 Received: from mail-ww0-f49.google.com ([74.125.82.49]:55573) by eggs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1OqXue-0006Vy-Qo for bug-gnu-emacs@gnu.org; Tue, 31 Aug 2010 16:58:36 -0400 Received: by wwb24 with SMTP id 24so4730863wwb.30 for ; Tue, 31 Aug 2010 13:58:35 -0700 (PDT) MIME-Version: 1.0 Received: by 10.227.208.85 with SMTP id gb21mr6089771wbb.167.1283288289554; Tue, 31 Aug 2010 13:58:09 -0700 (PDT) Received: by 10.216.65.140 with HTTP; Tue, 31 Aug 2010 13:58:09 -0700 (PDT) Date: Tue, 31 Aug 2010 16:58:09 -0400 X-Google-Sender-Auth: cCHm6jx3KtliSYnLs5VKrn1uCcw Message-ID: Subject: Documentation: `posn-actual-col-row' is unclear From: MON KEY To: bug-gnu-emacs@gnu.org 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: -4.1 (----) X-Debbugs-Envelope-To: submit 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.1 (-----) documentation of `posn-actual-col-row' is unclear. ,---- (documentation 'posn-actual-col-row) | | Return the actual column and row in position, measured in characters. | These are the actual row number in the window and character number in that row. | Return nil if position does not contain the actual position; in that case | `posn-col-row' can be used to get approximate values. | position should be a list of the form returned by the `event-start' | and `event-end' functions. | `---- How is a position, "measured in characters."? What is a, "character number in that row"? Is this equivalent to the return value of `char-to-string'? (char-to-string (car (posn-col-row (posn-at-point (window-point (selected-window) ) (selected-window))))) ;=> ";" At the very least the following portion of doc is poorly phrased: "These are the actual row number in the window and character number in that row." ^^^^^^^^^ Should be something more like, "This is the actual row number in the window and character number in that row." ^^^^^^^ However, even then the above definition is tautological: ME: "What is `posn-actual-col-row'?" DOC: "... the actual row number ..." Also, there is no mention of which list element of the list returned by the `event-start' this procedure is an accessor of e.g.: POS (COL . ROW) Likewise, there is no indication of the order of the return value is a cons of the form: (COLUMN . ROW) -- /s_P\ From debbugs-submit-bounces@debbugs.gnu.org Wed Sep 01 04:57:37 2010 Received: (at 6958) by debbugs.gnu.org; 1 Sep 2010 08:57:37 +0000 Received: from localhost ([127.0.0.1] helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1Oqj8S-0007yY-VG for submit@debbugs.gnu.org; Wed, 01 Sep 2010 04:57:37 -0400 Received: from fencepost.gnu.org ([140.186.70.10]) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1Oqj8Q-0007yR-FB for 6958@debbugs.gnu.org; Wed, 01 Sep 2010 04:57:35 -0400 Received: from eliz by fencepost.gnu.org with local (Exim 4.69) (envelope-from ) id 1OqjA1-0000uf-SI; Wed, 01 Sep 2010 04:59:13 -0400 From: Eli Zaretskii To: MON KEY In-reply-to: (message from MON KEY on Tue, 31 Aug 2010 16:58:09 -0400) Subject: Re: bug#6958: Documentation: `posn-actual-col-row' is unclear References: Message-Id: Date: Wed, 01 Sep 2010 04:59:13 -0400 X-Spam-Score: -5.3 (-----) X-Debbugs-Envelope-To: 6958 Cc: 6958@debbugs.gnu.org X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.11 Precedence: list Reply-To: Eli Zaretskii 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: -6.5 (------) > Date: Tue, 31 Aug 2010 16:58:09 -0400 > From: MON KEY > Cc: > > ,---- (documentation 'posn-actual-col-row) > | > | Return the actual column and row in position, measured in characters. > | These are the actual row number in the window and character number > in that row. > | Return nil if position does not contain the actual position; in that case > | `posn-col-row' can be used to get approximate values. > | position should be a list of the form returned by the `event-start' > | and `event-end' functions. > | > `---- > > How is a position, "measured in characters."? Not the position, the column and row numbers. The comma after "position" should have resolved the ambiguity; it did for me. > What is a, "character number in that row"? Quite simply, the ordinal number of a character. What is unclear here? > Is this equivalent to the return value of `char-to-string'? No. > At the very least the following portion of doc is poorly phrased: > "These are the actual row number in the window and character number in > that row." > ^^^^^^^^^ > > Should be something more like, > "This is the actual row number in the window and character number in that row." > ^^^^^^^ No, the original is correct: it talks about the column and row, plural, not singular. > However, even then the above definition is tautological: > ME: "What is `posn-actual-col-row'?" > DOC: "... the actual row number ..." You are confusing the function with its return value. the doc string does not describe the function, it describes its arguments and return value. > Also, there is no mention of which list element of the list returned > by the `event-start' this procedure is an accessor of e.g.: That's deliberate: the structure of the events is an implementation detail and is subject to change without notice. > Likewise, there is no indication of the order of the return value is a > cons of the form: > (COLUMN . ROW) Nitpicking: it says "column and row", so there's no reason to assume the order is not as it says. From debbugs-submit-bounces@debbugs.gnu.org Sat Oct 02 19:03:31 2010 Received: (at control) by debbugs.gnu.org; 2 Oct 2010 23:03:31 +0000 Received: from localhost ([127.0.0.1] helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1P2B75-0006PP-Jz for submit@debbugs.gnu.org; Sat, 02 Oct 2010 19:03:31 -0400 Received: from pantheon-po16.its.yale.edu ([130.132.50.72]) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1P2B74-0006PK-QQ for control@debbugs.gnu.org; Sat, 02 Oct 2010 19:03:31 -0400 Received: from furry (173-9-75-145-NewEngland.hfc.comcastbusiness.net [173.9.75.145]) (authenticated bits=0) by pantheon-po16.its.yale.edu (8.12.11.20060308/8.12.11) with ESMTP id o92N6WEp010378 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=NOT) for ; Sat, 2 Oct 2010 19:06:32 -0400 Received: by furry (Postfix, from userid 1000) id 7572BC018; Sat, 2 Oct 2010 19:06:32 -0400 (EDT) From: Chong Yidong To: control@debbugs.gnu.org Subject: close 6958 Date: Sat, 02 Oct 2010 19:06:32 -0400 Message-ID: <87eic8p53b.fsf@stupidchicken.com> MIME-Version: 1.0 Content-Type: text/plain X-YaleITSMailFilter: Version 1.2c (attachment(s) not renamed) 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 6958 + notabug close 6958 thanks From unknown Wed Sep 10 16:41:27 2025 Received: (at fakecontrol) by fakecontrolmessage; To: internal_control@debbugs.gnu.org From: Debbugs Internal Request Subject: Internal Control Message-Id: bug archived. Date: Sun, 31 Oct 2010 11:24:04 +0000 User-Agent: Fakemail v42.6.9 # This is a fake control message. # # The action: # bug archived. thanks # This fakemail brought to you by your local debbugs # administrator