aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEli Zaretskii2015-09-30 10:19:41 +0300
committerEli Zaretskii2015-09-30 10:19:41 +0300
commit47089e0cc85906831f5d078d460a581ad70d963a (patch)
tree8afabee5ed5acd3644cec4545bb60c29735c79ca
parente1877439d889e5584dabfd769338367f186e0741 (diff)
downloademacs-47089e0cc85906831f5d078d460a581ad70d963a.tar.gz
emacs-47089e0cc85906831f5d078d460a581ad70d963a.zip
Clarify documentation of pos-visible-in-window-p
* src/window.c (Fpos_visible_in_window_p): Clarify the meaning of t for POS. See http://lists.gnu.org/archive/html/emacs-devel/2015-09/msg01040.html for the original report. * doc/lispref/windows.texi (Window Start and End): Clarify the meaning of t for the POSITION argument of pos-visible-in-window-p.
-rw-r--r--doc/lispref/windows.texi2
-rw-r--r--src/window.c5
2 files changed, 4 insertions, 3 deletions
diff --git a/doc/lispref/windows.texi b/doc/lispref/windows.texi
index 00161b28b66..881d364232a 100644
--- a/doc/lispref/windows.texi
+++ b/doc/lispref/windows.texi
@@ -3179,7 +3179,7 @@ Locations that are partially obscured are not considered visible unless
3179@var{partially} is non-@code{nil}. The argument @var{position} defaults 3179@var{partially} is non-@code{nil}. The argument @var{position} defaults
3180to the current position of point in @var{window}; @var{window}, to the 3180to the current position of point in @var{window}; @var{window}, to the
3181selected window. If @var{position} is @code{t}, that means to check the 3181selected window. If @var{position} is @code{t}, that means to check the
3182last visible position in @var{window}. 3182first visible position of the last visible screen line in @var{window}.
3183 3183
3184This function considers only vertical scrolling. If @var{position} is 3184This function considers only vertical scrolling. If @var{position} is
3185out of view only because @var{window} has been scrolled horizontally, 3185out of view only because @var{window} has been scrolled horizontally,
diff --git a/src/window.c b/src/window.c
index 42a2ca68f14..0f35066c7d5 100644
--- a/src/window.c
+++ b/src/window.c
@@ -1686,8 +1686,9 @@ Return nil if that position is scrolled vertically out of view. If a
1686character is only partially visible, nil is returned, unless the 1686character is only partially visible, nil is returned, unless the
1687optional argument PARTIALLY is non-nil. If POS is only out of view 1687optional argument PARTIALLY is non-nil. If POS is only out of view
1688because of horizontal scrolling, return non-nil. If POS is t, it 1688because of horizontal scrolling, return non-nil. If POS is t, it
1689specifies the position of the last visible glyph in WINDOW. POS 1689specifies the position of the first glyph displayed on the last visible
1690defaults to point in WINDOW; WINDOW defaults to the selected window. 1690screen line in WINDOW. POS defaults to point in WINDOW; WINDOW defaults
1691to the selected window.
1691 1692
1692If POS is visible, return t if PARTIALLY is nil; if PARTIALLY is non-nil, 1693If POS is visible, return t if PARTIALLY is nil; if PARTIALLY is non-nil,
1693the return value is a list of 2 or 6 elements (X Y [RTOP RBOT ROWH VPOS]), 1694the return value is a list of 2 or 6 elements (X Y [RTOP RBOT ROWH VPOS]),