* bug#25796: 24.5; doc string of `posn-at-point'
@ 2017-02-19 18:46 Drew Adams
2017-02-25 8:42 ` Eli Zaretskii
0 siblings, 1 reply; 2+ messages in thread
From: Drew Adams @ 2017-02-19 18:46 UTC (permalink / raw)
To: 25796
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'
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2017-02-25 8:42 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2017-02-19 18:46 bug#25796: 24.5; doc string of `posn-at-point' Drew Adams
2017-02-25 8:42 ` Eli Zaretskii
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).