Skip to content

Commit

Permalink
docs: update formatters in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
rchl committed Aug 29, 2024
1 parent d133b55 commit 36eb8a6
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,14 @@ After changing a linter, you must restart Sublime Text.

The default formatter is `autopep8`. The possible formatters are:

| Name | Setting | Note |
|:---------------|:--------|:-----|
| autopep8 | `pylsp.plugins.autopep8.enabled` | |
| black | `pylsp.plugins.pylsp_black.enabled` | When enabling also make sure that `autopep8` and `yapf` are disabled. |
| ruff | `pylsp.plugins.ruff.formatEnabled` | Make sure to also enable `pylsp.plugins.ruff.enabled` and disable other formatters and linters. |
| yapf | `pylsp.plugins.yapf.enabled` | |

- ruff (`"pylsp.plugins.ruff.formatEnabled"` in the settings)
- yapf (`"pylsp.plugins.yapf.enabled"` in the settings)
- autopep8 (`"pylsp.plugins.autopep8.enabled"` in the settings)
- black (`"pylsp.plugins.pylsp_black.enabled"` in the settings. When enabling also make sure that `autopep8` and `yapf` are disabled.)
Expand Down

0 comments on commit 36eb8a6

Please sign in to comment.