emacs-diffs
[Top][All Lists]
Advanced

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

[Emacs-diffs] master 1c6a587: ; Clarify docs of pos-visible-in-window-p


From: Eli Zaretskii
Subject: [Emacs-diffs] master 1c6a587: ; Clarify docs of pos-visible-in-window-p some more
Date: Wed, 30 Sep 2015 09:46:45 +0000

branch: master
commit 1c6a58705b653b62c71266497564b1880c5b1340
Author: Eli Zaretskii <address@hidden>
Commit: Eli Zaretskii <address@hidden>

    ; Clarify docs of pos-visible-in-window-p some more
---
 doc/lispref/windows.texi |   14 ++++++++------
 src/window.c             |    5 +++--
 2 files changed, 11 insertions(+), 8 deletions(-)

diff --git a/doc/lispref/windows.texi b/doc/lispref/windows.texi
index 881d364..1da2d1c 100644
--- a/doc/lispref/windows.texi
+++ b/doc/lispref/windows.texi
@@ -3174,12 +3174,14 @@ position that works well with point, and thus 
@var{position} is not used.
 @defun pos-visible-in-window-p &optional position window partially
 This function returns address@hidden if @var{position} is within the
 range of text currently visible on the screen in @var{window}.  It
-returns @code{nil} if @var{position} is scrolled vertically out of view.
-Locations that are partially obscured are not considered visible unless
address@hidden is address@hidden  The argument @var{position} defaults
-to the current position of point in @var{window}; @var{window}, to the
-selected window.  If @var{position} is @code{t}, that means to check the
-first visible position of the last visible screen line in @var{window}.
+returns @code{nil} if @var{position} is scrolled vertically out of
+view.  Locations that are partially obscured are not considered
+visible unless @var{partially} is address@hidden  The argument
address@hidden defaults to the current position of point in
address@hidden; @var{window} defaults to the selected window.  If
address@hidden is @code{t}, that means to check either the first
+visible position of the last screen line in @var{window}, or the
+end-of-buffer position, whichever comes first.
 
 This function considers only vertical scrolling.  If @var{position} is
 out of view only because @var{window} has been scrolled horizontally,
diff --git a/src/window.c b/src/window.c
index 0f35066..8d899d6 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
 character is only partially visible, nil is returned, unless the
 optional argument PARTIALLY is non-nil.  If POS is only out of view
 because of horizontal scrolling, return non-nil.  If POS is t, it
-specifies the position of the first glyph displayed on the last visible
-screen line in WINDOW.  POS defaults to point in WINDOW; WINDOW defaults
+specifies the position of either the first position displayed on the
+last visible screen line in WINDOW, or the end-of-buffer position,
+whichever comes first.  POS defaults to point in WINDOW; WINDOW defaults
 to the selected window.
 
 If POS is visible, return t if PARTIALLY is nil; if PARTIALLY is non-nil,



reply via email to

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