Skip to content

Commit 5416310

Browse files
committed
chore(docs): auto-generate vimdoc
1 parent c72c3ae commit 5416310

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

doc/cinnamon.nvim.txt

+11-9
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*cinnamon.nvim.txt* For Neovim >= 0.8.0 Last change: 2024 July 12
1+
*cinnamon.nvim.txt* For Neovim >= 0.8.0 Last change: 2024 July 13
22

33
==============================================================================
44
Table of Contents *cinnamon.nvim-table-of-contents*
@@ -65,22 +65,24 @@ DEFAULT OPTIONS ~
6565
},
6666
---@class ScrollOptions
6767
options = {
68-
-- Post-movement callback
69-
callback = nil, ---@type function?
68+
-- Optional post-movement callback
69+
callback = function() end,
7070
-- Delay between each movement step (in ms)
7171
delay = 7,
7272
max_delta = {
73-
-- Maximum distance for line movements. Set to `nil` to disable
74-
line = nil, ---@type number?
75-
-- Maximum distance for column movements. Set to `nil` to disable
76-
column = nil, ---@type number?
73+
-- Maximum distance for line movements before smooth
74+
-- scrolling is skipped. Set to `false` to disable
75+
line = false,
76+
-- Maximum distance for column movements before smooth
77+
-- scrolling is skipped. Set to `false` to disable
78+
column = false,
7779
-- Maximum duration for a movement (in ms). Automatically adjusts the step delay
78-
time = 1000, ---@type number
80+
time = 1000,
7981
},
8082
-- The scrolling mode
8183
-- `cursor`: Smoothly scrolls the cursor for any movement
8284
-- `window`: Smoothly scrolls the window ONLY when the cursor moves out of view
83-
mode = "cursor", ---@type "cursor" | "window"
85+
mode = "cursor",
8486
},
8587
}
8688
<

0 commit comments

Comments
 (0)