From 5416310470cf3469b7cb5dd266c6d804b4fdb9e3 Mon Sep 17 00:00:00 2001 From: declancm Date: Sat, 13 Jul 2024 00:27:38 +0000 Subject: [PATCH] chore(docs): auto-generate vimdoc --- doc/cinnamon.nvim.txt | 20 +++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/doc/cinnamon.nvim.txt b/doc/cinnamon.nvim.txt index 7b444b3..e45b7b1 100644 --- a/doc/cinnamon.nvim.txt +++ b/doc/cinnamon.nvim.txt @@ -1,4 +1,4 @@ -*cinnamon.nvim.txt* For Neovim >= 0.8.0 Last change: 2024 July 12 +*cinnamon.nvim.txt* For Neovim >= 0.8.0 Last change: 2024 July 13 ============================================================================== Table of Contents *cinnamon.nvim-table-of-contents* @@ -65,22 +65,24 @@ DEFAULT OPTIONS ~ }, ---@class ScrollOptions options = { - -- Post-movement callback - callback = nil, ---@type function? + -- Optional post-movement callback + callback = function() end, -- Delay between each movement step (in ms) delay = 7, max_delta = { - -- Maximum distance for line movements. Set to `nil` to disable - line = nil, ---@type number? - -- Maximum distance for column movements. Set to `nil` to disable - column = nil, ---@type number? + -- Maximum distance for line movements before smooth + -- scrolling is skipped. Set to `false` to disable + line = false, + -- Maximum distance for column movements before smooth + -- scrolling is skipped. Set to `false` to disable + column = false, -- Maximum duration for a movement (in ms). Automatically adjusts the step delay - time = 1000, ---@type number + time = 1000, }, -- The scrolling mode -- `cursor`: Smoothly scrolls the cursor for any movement -- `window`: Smoothly scrolls the window ONLY when the cursor moves out of view - mode = "cursor", ---@type "cursor" | "window" + mode = "cursor", }, } <