From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Lars Ingebrigtsen Newsgroups: gmane.emacs.bugs Subject: bug#21231: 25.0.50; doc string of `marker-position' Date: Sun, 01 May 2016 00:03:55 +0200 Message-ID: <87k2je92k4.fsf@gnus.org> References: NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain X-Trace: ger.gmane.org 1462053944 32724 80.91.229.3 (30 Apr 2016 22:05:44 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Sat, 30 Apr 2016 22:05:44 +0000 (UTC) Cc: 21231@debbugs.gnu.org To: Drew Adams Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Sun May 01 00:05:32 2016 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by plane.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1awd12-0001z1-1w for geb-bug-gnu-emacs@m.gmane.org; Sun, 01 May 2016 00:05:32 +0200 Original-Received: from localhost ([::1]:59893 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1awd0y-0006cW-0D for geb-bug-gnu-emacs@m.gmane.org; Sat, 30 Apr 2016 18:05:28 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:58480) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1awd0n-0006OW-J7 for bug-gnu-emacs@gnu.org; Sat, 30 Apr 2016 18:05:23 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1awd0b-0005OZ-TN for bug-gnu-emacs@gnu.org; Sat, 30 Apr 2016 18:05:12 -0400 Original-Received: from debbugs.gnu.org ([208.118.235.43]:46309) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1awd0b-0005Nd-Qp for bug-gnu-emacs@gnu.org; Sat, 30 Apr 2016 18:05:05 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1awd0Y-0006Nc-DG for bug-gnu-emacs@gnu.org; Sat, 30 Apr 2016 18:05:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Lars Ingebrigtsen Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sat, 30 Apr 2016 22:05:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 21231 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: Original-Received: via spool by 21231-submit@debbugs.gnu.org id=B21231.146205386424459 (code B ref 21231); Sat, 30 Apr 2016 22:05:02 +0000 Original-Received: (at 21231) by debbugs.gnu.org; 30 Apr 2016 22:04:24 +0000 Original-Received: from localhost ([127.0.0.1]:58643 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1awczv-0006MR-OD for submit@debbugs.gnu.org; Sat, 30 Apr 2016 18:04:23 -0400 Original-Received: from hermes.netfonds.no ([80.91.224.195]:60904) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1awczt-0006MJ-SZ for 21231@debbugs.gnu.org; Sat, 30 Apr 2016 18:04:22 -0400 Original-Received: from cm-84.215.1.64.getinternet.no ([84.215.1.64] helo=mouse) by hermes.netfonds.no with esmtpsa (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.84_2) (envelope-from ) id 1awczT-0007Uk-Qi; Sun, 01 May 2016 00:04:21 +0200 In-Reply-To: (Drew Adams's message of "Mon, 10 Aug 2015 08:48:24 -0700 (PDT)") User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/25.1.50 (gnu/linux) 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:117457 Archived-At: Drew Adams writes: > The doc string is misleading or confusing. Please follow what is said > in the Elisp manual. > > The doc string says: > > Return the position MARKER points at, as a character number. > > Character number? What is that? It either means nothing or it means > something we don't want to convey here: the integer value of a > character. > > The Emacs way of talking about this is to refer to it as a "buffer > position". It is a positive integer. > > The manual just says "position". If you want to add that it is a > positive integer, fine. > > And it would be better if the first line indicated the nil possibility. > Something like: > > Return position of MARKER, or nil if it points nowhere. > If a position, it is a positive integer. I don't think the second sentence is necessary. A "position" is clear enough. I've installed that on the trunk. -- (domestic pets only, the antidote for overdose, milk.) bloggy blog: http://lars.ingebrigtsen.no