diff options
| author | Eli Zaretskii | 2017-11-04 18:09:01 +0200 |
|---|---|---|
| committer | Eli Zaretskii | 2017-11-04 18:09:01 +0200 |
| commit | 369da28702a60543391bf9576eb904d21ca8ea09 (patch) | |
| tree | ccc60c38f9e46450ebadc2cae3c5b267cdd6ad67 | |
| parent | 93818eed8ab9840095911be7b0ca0f2104320ea0 (diff) | |
| download | emacs-369da28702a60543391bf9576eb904d21ca8ea09.tar.gz emacs-369da28702a60543391bf9576eb904d21ca8ea09.zip | |
Improve documentation of 'window-scroll-functions'
* doc/lispref/windows.texi (Window Hooks): Clarify the values of
arguments of 'window-scroll-functions' functions.
* src/xdisp.c (syms_of_xdisp) <window-scroll-functions>: Doc fix.
| -rw-r--r-- | doc/lispref/windows.texi | 5 | ||||
| -rw-r--r-- | src/xdisp.c | 3 |
2 files changed, 7 insertions, 1 deletions
diff --git a/doc/lispref/windows.texi b/doc/lispref/windows.texi index fc642fe9447..e1eac457179 100644 --- a/doc/lispref/windows.texi +++ b/doc/lispref/windows.texi | |||
| @@ -5127,7 +5127,10 @@ redisplaying a window with scrolling. Displaying a different buffer in | |||
| 5127 | the window also runs these functions. | 5127 | the window also runs these functions. |
| 5128 | 5128 | ||
| 5129 | This variable is not a normal hook, because each function is called with | 5129 | This variable is not a normal hook, because each function is called with |
| 5130 | two arguments: the window, and its new display-start position. | 5130 | two arguments: the window, and its new display-start position. At the |
| 5131 | time of the call, the display-start position of the window argument is | ||
| 5132 | already set to its new value, and the buffer to be displayed in the | ||
| 5133 | window is already set as the current buffer. | ||
| 5131 | 5134 | ||
| 5132 | These functions must take care when using @code{window-end} | 5135 | These functions must take care when using @code{window-end} |
| 5133 | (@pxref{Window Start and End}); if you need an up-to-date value, you | 5136 | (@pxref{Window Start and End}); if you need an up-to-date value, you |
diff --git a/src/xdisp.c b/src/xdisp.c index b8bb6ba8dfc..baf075b1c8e 100644 --- a/src/xdisp.c +++ b/src/xdisp.c | |||
| @@ -32569,6 +32569,9 @@ display-start position. | |||
| 32569 | These functions are called whenever the `window-start' marker is modified, | 32569 | These functions are called whenever the `window-start' marker is modified, |
| 32570 | either to point into another buffer (e.g. via `set-window-buffer') or another | 32570 | either to point into another buffer (e.g. via `set-window-buffer') or another |
| 32571 | place in the same buffer. | 32571 | place in the same buffer. |
| 32572 | When each function is called, the `window-start' marker of its window | ||
| 32573 | argument has been already set to the new value, and the buffer which that | ||
| 32574 | window will display is set to be the current buffer. | ||
| 32572 | Note that the value of `window-end' is not valid when these functions are | 32575 | Note that the value of `window-end' is not valid when these functions are |
| 32573 | called. | 32576 | called. |
| 32574 | 32577 | ||