Skip to content

Commit ec2c7ca

Browse files
pgirauddhruvmanila
andauthored
Improve docs for ALE plugin for vim (#14335)
2 different fixers are available in ALE : - ruff which runs `ruff check --fix` command (useful for example when isort is enabled in lint config), - ruff_format which runs `run format` command. The documentation was missing `ruff` as a possible fixer in ALE. --------- Co-authored-by: Dhruv Manilawala <[email protected]>
1 parent 924741c commit ec2c7ca

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

docs/editors/setup.md

+6-3
Original file line numberDiff line numberDiff line change
@@ -150,12 +150,15 @@ extension for [coc.nvim](https://github.com/neoclide/coc.nvim).
150150
<summary>With the <a href="https://github.com/dense-analysis/ale">ALE</a> plugin for Vim or Neovim.</summary>
151151

152152
```vim
153-
" Linter
153+
" Linters
154154
let g:ale_linters = { "python": ["ruff"] }
155-
" Formatter
156-
let g:ale_fixers = { "python": ["ruff_format"] }
155+
" Fixers
156+
let g:ale_fixers = { "python": ["ruff", "ruff_format"] }
157157
```
158158

159+
For the fixers, `ruff` will run `ruff check --fix` (to fix all auto-fixable problems) whereas
160+
`ruff_format` will run `ruff format`.
161+
159162
</details>
160163

161164
<details>

0 commit comments

Comments
 (0)