nvimdev / nvimdev/lspsaga.nvim
DOCS: Make config setting clearer
Nobody has claimed this yet.
- Dominant language
- Lua
- Stars
- 3.8k
- Forks
- 308
- PR merge metrics
- No merged PRs in 30d
Description
I was looking for how to disable the lightbulb in the statusline here: https://nvimdev.github.io/lspsaga/lightbulb/
But I was unsure what key should be used in the config. I discovered that I could just do
init = function() require('lspsaga').setup({
lightbulb = {sign = false},
}) end
but it would be nice that the docs showed that "lightbulb" is the key to use. It might be relevant for other docs as well.
Maybe change the title "Default options" to "Default options (lightbulb)" or show a code example
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open the linked lightbulb documentation page and inspect the “Default options” section. Clarify that lightbulb is the configuration key, using the shown setup example if appropriate; done means readers can identify the key needed to disable the lightbulb.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- lua
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 50/100