unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Drew Adams <drew.adams@oracle.com>
To: 21231@debbugs.gnu.org
Subject: bug#21231: 25.0.50; doc string of `marker-position'
Date: Mon, 10 Aug 2015 08:48:24 -0700 (PDT)	[thread overview]
Message-ID: <df274984-6797-4dae-a93d-8ee807c0670b@default> (raw)

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.


In GNU Emacs 25.0.50.1 (i686-pc-mingw32)
 of 2014-10-20 on LEG570
Bzr revision: 118168 rgm@gnu.org-20141020195941-icp42t8ttcnud09g
Windowing system distributor `Microsoft Corp.', version 6.1.7601
Configured using:
 `configure --enable-checking=yes,glyphs CPPFLAGS=-DGLYPH_DEBUG=1'





             reply	other threads:[~2015-08-10 15:48 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-08-10 15:48 Drew Adams [this message]
2016-04-30 22:03 ` bug#21231: 25.0.50; doc string of `marker-position' Lars Ingebrigtsen

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.gnu.org/software/emacs/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=df274984-6797-4dae-a93d-8ee807c0670b@default \
    --to=drew.adams@oracle.com \
    --cc=21231@debbugs.gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).