unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Drew Adams <drew.adams@oracle.com>
To: 25796@debbugs.gnu.org
Subject: bug#25796: 24.5; doc string of `posn-at-point'
Date: Sun, 19 Feb 2017 10:46:53 -0800 (PST)	[thread overview]
Message-ID: <1c0d2b8d-61f1-4505-b3ba-c53d97048eb4@default> (raw)

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=/c/usr --host=i686-pc-mingw32'





             reply	other threads:[~2017-02-19 18:46 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-02-19 18:46 Drew Adams [this message]
2017-02-25  8:42 ` bug#25796: 24.5; doc string of `posn-at-point' Eli Zaretskii

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=1c0d2b8d-61f1-4505-b3ba-c53d97048eb4@default \
    --to=drew.adams@oracle.com \
    --cc=25796@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).