nvimdev / lspsaga.nvim

improve neovim lsp experience
MIT License
3.47k stars 288 forks source link

Document defaults in lua format #1359

Open mosheavni opened 10 months ago

mosheavni commented 10 months ago

I love this plugin, however I think it could be documented better. for example, I wanted to disable lightbulb. I went to the docs: https://nvimdev.github.io/lspsaga/lightbulb/ but the defaults don't contain the key. is it lightbulb? is it codeaction_lightbulb (like it was in the past)? I had to go to the source code and figure it out.

Instead of this pretty table:

image

i would much rather seeing something like:

require('lspsaga').setup({
  -- ...
  lightbulb = {
    enable = true,
    sign = true, -- show sign in status column
    debounce = 10, -- timer debounce
    sign_priority = 40, -- sign priority
    virtual_text = true, -- show virtual text at the end of line
    enable_in_insert = true,
  },
  -- ...
})

Alternatively, a single page with all the defaults.

also in some cases not all options are documented on the website. Thanks!

mosheavni commented 5 months ago

nothing?

glepnir commented 5 months ago

when i available on doc improve...

mosheavni commented 3 months ago

@glepnir any chance to get that going? this is really not something difficult