This could help beginners to get autocompletion, catch mistakes earlier,
and allow them to skip the docs for simple configs.
This is not perfect because a lot of the plugins type all of their keys
as required, even though they have defaults, but this is good enough.
The following lines do nothing and can be removed:
format = function(diagnostic)
local diagnostic_message = {
[vim.diagnostic.severity.ERROR] = diagnostic.message,
[vim.diagnostic.severity.WARN] = diagnostic.message,
[vim.diagnostic.severity.INFO] = diagnostic.message,
[vim.diagnostic.severity.HINT] = diagnostic.message,
}
return diagnostic_message[diagnostic.severity]
end,
The following line causes diagnostics which aren't of severity level
error to not have the specific text area underlined. This is less useful
than the default of showing underlines for all diagnostic levels, so
remove this line as well:
underline = { severity = vim.diagnostic.severity.ERROR },
The functions of vim.highlight were renamed to vim.hl on commit
18b43c331d8a0ed87d7cbefe2a18543b8e4ad360 of neovim, which was applied
with the release of nvim version 0.11.
Now, the use of vim.highlight is deprecated, and instead, one should
use vim.hl functions.
In practice, vim.highlight is still working, however, asking for help
for vim.highlight.on_yank fails (E149), while asking for help for
vim.hl.on_yank works as expected. So, by updating the used function, a
new user will have easier time looking getting the relevant help.
Co-authored-by: Omri Sarig <omri.sarig@prevas.dk>
* Replace vim.opt with vim.o
Because it offers a nicer interface and info on hover.
For now leave vim.opt when using the table interface (until vim.o
with tables is implemented)
* Add type hint for vim.opt.rtp
* Add a comment about using vim.opt instead of vim.o
* docs: clarify using opts = {} vs config = function() ... require('plugin').setup({}) .. end
The current documentation mentioning that using "require" is equivalent to using "opts" without detailing the use in the "config = function()" block seems inaccurate.
Lower in the configuration the "config = function()" block is used without clarifying why it needed and what it does.
This clarification may help new users understand the difference between the two, or how and where to place the "require" statement.
* Update init.lua
* remove whitespace
The which-key plugin used to rely on vim.opt.timeoutlen, but it was
updated a few months ago to use its own opt.delay instead.
8ab96b38a2/NEWS.md?plain=1#L10
I set which-key's delay to 0 ms because it makes it feel snappy and
responsive! That way, we give new users a good first impression.
```
require('gitsigns').setup({ ... })
```
This was the first occurrence
It may be nice to have the same style everywhere
Cosmetic change (just to make docs/comments even more perfect)
Ori Perry
orip
Sangho Lee
Ronan Dalton
Francesc Elies
Kartik Vashistha
Arvin Verain
Omri Sarig
guru245
brian tan
Liam Dyer
Dmytro Onypko
Theo P.
dasvh
Sander
RulentWave
Crypto-Spartan
Chris Patti
Ari Pollak
Jonas Zeltner
Aryan Rajoria
Rob
Joaquín Guerra
GeloCraft
bleacheda
Diorman Colmenares
Nhan Luu
Tomas Gareau
Ryan Jensen
ben fleis
Artem Dragunov
Miha
gloomy-lemon-debatable
Will Winder