Skip to content

Commit

Permalink
chore(build): auto-generate vimdoc
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Jun 9, 2024
1 parent d9596e7 commit 4726c9e
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions doc/spellwarn.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand All @@ -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*
Expand Down

0 comments on commit 4726c9e

Please sign in to comment.