Skip to content

Commit daaee68

Browse files
committed
fix: update docstring
1 parent 7dc7bbc commit daaee68

File tree

1 file changed

+11
-10
lines changed

1 file changed

+11
-10
lines changed

lua/hop/window.lua

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -34,24 +34,25 @@
3434
---@field line string
3535
---@field line_cliped string
3636
---@field col_bias WindowCol Bias column of the left clipped line
37-
---@field off_bias WindowCol Bias cell column of the left clipped blank cells for 'virtualedit' is enabled
37+
---@field off_bias WindowCell Bias cell column of the left clipped blank cells for 'virtualedit' is enabled
3838

3939
-- The Cursor and LineContext under WindowContext:
4040
-- ```
41-
-- | virt |
42-
-- | col_bias | | off |
43-
-- 1****************|========~~~~~~$~~|
44-
-- | win_offset | win_width |
41+
-- | virt |
42+
-- | col_bias | | off |
43+
-- 1*********************|========|~~~~~$~~|
44+
-- | win_offset | win_width |
4545
--
46-
-- | off |
47-
-- 2*****|~~~~~~~~~~|~~~~~~~~~~~~~~$~~|
48-
-- | off_bias | win_width |
46+
-- | off |
47+
-- | col_bias | off_bias | virt |
48+
-- 2**********|~~~~~~~~~~|~~~~~~~~~~~~~~$~~|
49+
-- | win_offset | win_width |
4950
-- ```
5051
-- '1' : line 1 with long line string
5152
-- '2' : line 2 with short line string
5253
-- '*' : line string hidded to window left
5354
-- '=' : line string displayed on window
54-
-- '~' : blank cells with any text after line string
55+
-- '~' : blank cells without any text after line string
5556
-- '$' : cursor with 'virtualedit' enabled
5657
--
5758
---@class WindowContext
@@ -330,7 +331,7 @@ function M.clip_line_context(win_ctx, line_ctx, opts)
330331
end
331332
end
332333

333-
---@type WindowCol
334+
---@type WindowCell
334335
local off_bias = 0
335336
if win_ctx.win_offset > line_cells then
336337
off_bias = win_ctx.win_offset - line_cells

0 commit comments

Comments
 (0)