branch: externals/doc-view-follow
commit f1395185fdcb418edb2f0d813ecccf0e210d11b1
Author: Paul Nelson <[email protected]>
Commit: Paul Nelson <[email protected]>
Clarify docstring of doc-dual-view--order-windows
* doc-dual-view.el (doc-dual-view--order-windows): Make the docstring
more precise about how windows are ordered: first by horizontal
position (leftmost), then by vertical position (topmost) when windows
have the same horizontal position.
---
doc-dual-view.el | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/doc-dual-view.el b/doc-dual-view.el
index 5cc2cd3091..870c30b0ac 100644
--- a/doc-dual-view.el
+++ b/doc-dual-view.el
@@ -67,7 +67,7 @@ redisplay-func)."
(function :tag "Max Page Function"))))
(defun doc-dual-view--order-windows (windows)
- "Order WINDOWS based on their position, leftmost (or topmost if equal)
first."
+ "Order WINDOWS based on their position: leftmost, then topmost."
(sort windows
(lambda (window-a window-b)
(let* ((edges-a (window-edges window-a))
