diff options
| author | Eli Zaretskii | 2015-09-30 10:19:41 +0300 |
|---|---|---|
| committer | Eli Zaretskii | 2015-09-30 10:19:41 +0300 |
| commit | 47089e0cc85906831f5d078d460a581ad70d963a (patch) | |
| tree | 8afabee5ed5acd3644cec4545bb60c29735c79ca /src | |
| parent | e1877439d889e5584dabfd769338367f186e0741 (diff) | |
| download | emacs-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.
Diffstat (limited to 'src')
| -rw-r--r-- | src/window.c | 5 |
1 files changed, 3 insertions, 2 deletions
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 | |||
| 1686 | character is only partially visible, nil is returned, unless the | 1686 | character is only partially visible, nil is returned, unless the |
| 1687 | optional argument PARTIALLY is non-nil. If POS is only out of view | 1687 | optional argument PARTIALLY is non-nil. If POS is only out of view |
| 1688 | because of horizontal scrolling, return non-nil. If POS is t, it | 1688 | because of horizontal scrolling, return non-nil. If POS is t, it |
| 1689 | specifies the position of the last visible glyph in WINDOW. POS | 1689 | specifies the position of the first glyph displayed on the last visible |
| 1690 | defaults to point in WINDOW; WINDOW defaults to the selected window. | 1690 | screen line in WINDOW. POS defaults to point in WINDOW; WINDOW defaults |
| 1691 | to the selected window. | ||
| 1691 | 1692 | ||
| 1692 | If POS is visible, return t if PARTIALLY is nil; if PARTIALLY is non-nil, | 1693 | If POS is visible, return t if PARTIALLY is nil; if PARTIALLY is non-nil, |
| 1693 | the return value is a list of 2 or 6 elements (X Y [RTOP RBOT ROWH VPOS]), | 1694 | the return value is a list of 2 or 6 elements (X Y [RTOP RBOT ROWH VPOS]), |