[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

bug#25796: 24.5; doc string of `posn-at-point'

From: Drew Adams
Subject: bug#25796: 24.5; doc string of `posn-at-point'
Date: Sun, 19 Feb 2017 10:46:53 -0800 (PST)

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 via email to

[Prev in Thread] Current Thread [Next in Thread]