aboutsummaryrefslogtreecommitdiff
path: root/runtime/doc/ui.txt
diff options
context:
space:
mode:
authorJustin M. Keyes <justinkz@gmail.com>2019-04-08 03:44:00 +0200
committerGitHub <noreply@github.com>2019-04-08 03:44:00 +0200
commit11bf89e3b58be1dd534b4ea49b1988150cf7d4b8 (patch)
treed13bc141aa3ea8b28c38da091d4cf6af1fcbc040 /runtime/doc/ui.txt
parent943bedfc86abb2c6ac20079c1c3a4baac1bd726e (diff)
parentce76dffda46db99f073e4bcc159507024d2bfbe8 (diff)
downloadrneovim-11bf89e3b58be1dd534b4ea49b1988150cf7d4b8.tar.gz
rneovim-11bf89e3b58be1dd534b4ea49b1988150cf7d4b8.tar.bz2
rneovim-11bf89e3b58be1dd534b4ea49b1988150cf7d4b8.zip
Merge #9796 from justinmk/doc
Diffstat (limited to 'runtime/doc/ui.txt')
-rw-r--r--runtime/doc/ui.txt10
1 files changed, 7 insertions, 3 deletions
diff --git a/runtime/doc/ui.txt b/runtime/doc/ui.txt
index ab077397a4..98476ea8fa 100644
--- a/runtime/doc/ui.txt
+++ b/runtime/doc/ui.txt
@@ -325,9 +325,13 @@ numerical highlight `id`:s to the actual attributes.
indicates the visible cursor position.
["grid_scroll", grid, top, bot, left, right, rows, cols]
- Scroll the text in the a region of `grid`. The diagrams below illustrate
- what will happen, depending on the scroll direction. "=" is used to
- represent the SR(scroll region) boundaries and "-" the moved rectangles.
+ Scroll a region of `grid`. This is semantically unrelated to editor
+ |scrolling|, rather this is an optimized way to say "copy these screen
+ cells".
+
+ The following diagrams show what happens per scroll direction.
+ "===" represents the SR (scroll region) boundaries.
+ "---" represents the moved rectangles.
Note that dst and src share a common region.
If `rows` is bigger than 0, move a rectangle in the SR up, this can