From 4726c9e131cf12a6e7abec1fe1d36c3e1fcdcbf2 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Sun, 9 Jun 2024 15:49:17 +0000 Subject: [PATCH] chore(build): auto-generate vimdoc --- doc/spellwarn.txt | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/doc/spellwarn.txt b/doc/spellwarn.txt index b75c957..7ec674d 100644 --- a/doc/spellwarn.txt +++ b/doc/spellwarn.txt @@ -58,14 +58,14 @@ Pass any of the following options to `require("spellwarn").setup()` "TextChangedP", "TextChangedT", }, - ft_config = { -- spellcheck method: "cursor", "iter", "treesitter", or boolean + ft_config = { -- spellcheck method: "cursor", "iter", or boolean alpha = false, help = false, lazy = false, lspinfo = false, mason = false, }, - ft_default = true, -- whether to enable or disable for all filetypes by default + ft_default = true, -- default option for unspecified filetypes max_file_size = nil, -- maximum file size to check in lines (nil for no limit) severity = { -- severity for each spelling error type (false to disable diagnostics for that type) spellbad = "WARN", @@ -83,9 +83,9 @@ false }` will mean that `alpha`, `mason`, etc. are set to true) but that `spellcap` to be nil. You can pass any of `cursor`, `iter`, `treesitter`, `false`, or `true` as options to `ft_config`. The default method is `cursor`, which iterates through the buffer with `]s`. There is also `iter`, which uses -the Lua API, and `treesitter`, which uses the Lua API and Treesitter (and falls -back on `iter` if Treesitter is unavailable). Finally, `false` disables -Spellwarn for that filetype and `true` uses the default (`cursor`). +Treesitter (if available) and the Lua API. Finally, `false` disables Spellwarn +for that filetype and `true` uses the default (`cursor`). _Note: iter doesn’t +show spellcap errors, but works well other than that. I recommend it._ USAGE *spellwarn-spellwarn.nvim-usage*