Skip to content

Commit fae06c7

Browse files
authored
Update README.md
1 parent 4fdaf49 commit fae06c7

1 file changed

Lines changed: 15 additions & 14 deletions

File tree

README.md

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -30,25 +30,14 @@ Neovim](https://github.com/python-rope/rope/wiki/Rope-in-Vim-or-Neovim). For
3030
other editors, refer to your IDE/text editor's documentation on how to setup a
3131
language server.
3232

33-
## Configuration
34-
35-
You can enable rename support using pylsp-rope with workspace config key
36-
`pylsp.plugins.pylsp_rope.rename`.
37-
38-
Note that this differs from the config key `pylsp.plugins.rope_rename.enabled`
39-
that is used for the rope rename implementation using the python-lsp-rope's
40-
builtin `rope_rename` plugin. To avoid confusion, avoid enabling more than one
41-
python-lsp-server rename plugin. In other words, you should set both
42-
`pylsp.plugins.rope_rename.enabled = false` and `pylsp.plugins.jedi_rename.enabled = false`
43-
when pylsp-rope rename is enabled.
44-
4533
## Features
4634

4735
This plugin adds the following features to python-lsp-server:
4836

4937
Rename:
5038

51-
- rename everything: classes, functions, modules, packages (disabled by default)
39+
- implemented: variables, classes, functions (disabled by default)
40+
- coming soon: modules, packages (disabled by default)
5241

5342
Code Action:
5443

@@ -144,9 +133,21 @@ When CodeAction is triggered and the cursor is on an undefined Python
144133
variable, generate an empty variable/function/class/module/package for that
145134
name.
146135

136+
## Configuration
137+
138+
You can enable rename support using pylsp-rope with workspace config key
139+
`pylsp.plugins.pylsp_rope.rename`.
140+
141+
Note that this differs from the config key `pylsp.plugins.rope_rename.enabled`
142+
that is used for the rope rename implementation using the python-lsp-rope's
143+
builtin `rope_rename` plugin. To avoid confusion, avoid enabling more than one
144+
python-lsp-server rename plugin. In other words, you should set both
145+
`pylsp.plugins.rope_rename.enabled = false` and `pylsp.plugins.jedi_rename.enabled = false`
146+
when pylsp-rope rename is enabled.
147+
147148
## Caveat
148149

149-
Support for working on unsaved document is currently experimental.
150+
Support for working on unsaved document is currently experimental, but it should work.
150151

151152
This plugin is in early development, so expect some bugs. Please report in
152153
[Github issue tracker](https://github.com/python-lsp/python-lsp-server/issues)

0 commit comments

Comments
 (0)