mirror of https://github.com/astral-sh/ruff
Fix doc for Neovim setting examples (#18491)
## Summary This PR fixes an error in the example Neovim configuration on [this documentation page](https://docs.astral.sh/ruff/editors/settings/#configuration). The `configuration` block should be nested under `settings`, consistent with other properties and as outlined [here](https://docs.astral.sh/ruff/editors/setup/#neovim). I encountered this issue when copying the example to configure ruff integration in my neovim - the config didn’t work until I corrected the nesting. ## Test Plan - [x] Confirmed that the corrected configuration works in a real Neovim + Ruff setup - [x] Verified that the updated configuration renders correctly in MkDocs <img width="382" alt="image" src="https://github.com/user-attachments/assets/0722fb35-8ffa-4b10-90ba-c6e8417e40bf" />
This commit is contained in:
parent
db8db536f8
commit
8d24760643
|
|
@ -66,9 +66,11 @@ _Using configuration file path:_
|
||||||
```lua
|
```lua
|
||||||
require('lspconfig').ruff.setup {
|
require('lspconfig').ruff.setup {
|
||||||
init_options = {
|
init_options = {
|
||||||
|
settings = {
|
||||||
configuration = "~/path/to/ruff.toml"
|
configuration = "~/path/to/ruff.toml"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
=== "Zed"
|
=== "Zed"
|
||||||
|
|
@ -117,6 +119,7 @@ _Using inline configuration:_
|
||||||
```lua
|
```lua
|
||||||
require('lspconfig').ruff.setup {
|
require('lspconfig').ruff.setup {
|
||||||
init_options = {
|
init_options = {
|
||||||
|
settings = {
|
||||||
configuration = {
|
configuration = {
|
||||||
lint = {
|
lint = {
|
||||||
unfixable = {"F401"},
|
unfixable = {"F401"},
|
||||||
|
|
@ -135,6 +138,7 @@ _Using inline configuration:_
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
=== "Zed"
|
=== "Zed"
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue