You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -11,17 +11,17 @@ A [Python](https://www.python.org/) [Language Server](https://microsoft.github.i
11
11
12
12
## Installation
13
13
14
-
Some frameworks, like coc-jedi and vscode-python, will install and manage jedi-language-server for you. If you're setting up manually, you can run the following from your command line (bash / zsh):
14
+
Some frameworks, like coc-jedi and vscode-python, will install and manage `jedi-language-server` for you. If you're setting up manually, you can run the following from your command line (bash / zsh):
15
15
16
16
```bash
17
17
pip install -U jedi-language-server
18
18
```
19
19
20
-
Alternatively (and preferably), use [pipx](https://github.com/pipxproject/pipx) to keep jedi-language-server and its dependencies isolated from your other Python dependencies. Don't worry, jedi is smart enough to figure out which Virtual environment you're currently using!
20
+
Alternatively (and preferably), use [pipx](https://github.com/pipxproject/pipx) to keep `jedi-language-server` and its dependencies isolated from your other Python dependencies. Don't worry, jedi is smart enough to figure out which Virtual environment you're currently using!
21
21
22
22
## Editor Setup
23
23
24
-
The following instructions show how to use jedi-language-server with your development tooling. The instructions assume you have already installed jedi-language-server.
24
+
The following instructions show how to use `jedi-language-server` with your development tooling. The instructions assume you have already installed `jedi-language-server`.
25
25
26
26
### Vim / Neovim
27
27
@@ -45,13 +45,13 @@ Note: this list is non-exhaustive. If you know of a great choice not included in
45
45
46
46
### Visual Studio Code (vscode)
47
47
48
-
Starting from the [October 2021 release](https://github.com/microsoft/vscode-python/releases/tag/2021.10.1317843341), set the `python.languageServer` setting to `Jedi` to use jedi-language-server.
48
+
Starting from the [October 2021 release](https://github.com/microsoft/vscode-python/releases/tag/2021.10.1317843341), set the `python.languageServer` setting to `Jedi` to use `jedi-language-server`.
jedi-language-server supports the following [initializationOptions](https://microsoft.github.io/language-server-protocol/specification#initialize):
54
+
`jedi-language-server` supports the following [initializationOptions](https://microsoft.github.io/language-server-protocol/specification#initialize):
55
55
56
56
```json
57
57
{
@@ -107,12 +107,12 @@ The different sections of the InitializationOptions are explained below, in deta
107
107
108
108
### markupKindPreferred
109
109
110
-
The preferred MarkupKind for all jedi-language-server messages that take [MarkupContent](https://microsoft.github.io/language-server-protocol/specification#markupContent).
110
+
The preferred MarkupKind for all `jedi-language-server` messages that take [MarkupContent](https://microsoft.github.io/language-server-protocol/specification#markupContent).
111
111
112
112
- type: `string`
113
113
- accepted values: `"markdown"`, `"plaintext"`
114
114
115
-
If omitted, jedi-language-server defaults to the client-preferred configuration. If there is no client-preferred configuration, jedi language server users `"plaintext"`.
115
+
If omitted, `jedi-language-server` defaults to the client-preferred configuration. If there is no client-preferred configuration, jedi language server users `"plaintext"`.
116
116
117
117
### jediSettings.autoImportModules
118
118
@@ -329,7 +329,7 @@ Disable hover text identified by name in list of jedi-type specified.
329
329
330
330
#### hover.disable.\[jedi-type\].fullNames
331
331
332
-
Disable hover text identified by the fully qualified name in list of jedi-type specified. If no fully qualified name can be found, jedi-language-server will default to the name to prevent any unexpected behavior for users (relevant for jedi types like keywords that don't have full names).
332
+
Disable hover text identified by the fully qualified name in list of jedi-type specified. If no fully qualified name can be found, `jedi-language-server` will default to the name to prevent any unexpected behavior for users (relevant for jedi types like keywords that don't have full names).
333
333
334
334
- type: `string[]`
335
335
- default: `[]`
@@ -390,7 +390,7 @@ Maximum number of symbols returned by a call to `workspace/symbols`.
390
390
}
391
391
```
392
392
393
-
A value less than or equal to zero removes the maximum and allows jedi-language-server to return all workplace symbols found by jedi.
393
+
A value less than or equal to zero removes the maximum and allows `jedi-language-server` to return all workplace symbols found by jedi.
394
394
395
395
### workspace.symbols.ignoreFolders
396
396
@@ -415,15 +415,15 @@ If you manually set this option, it overrides the default. Setting it to an empt
415
415
416
416
Diagnostics are provided by Python's built-in `compile` function.
417
417
418
-
If you would like additional diagnostics (from [pylint](https://github.com/PyCQA/pylint), [mypy](https://github.com/python/mypy), etc.), we recommend using other tools (like [diagnostic-language-server](https://github.com/iamcco/diagnostic-languageserver)) to complement `jedi-language-server`.
418
+
If you would like additional diagnostics, we recommend using other tools (like [diagnostic-language-server](https://github.com/iamcco/diagnostic-languageserver)) to complement `jedi-language-server`.
419
419
420
420
## Code Formatting
421
421
422
422
Again, we recommend that you use [diagnostic-language-server](https://github.com/iamcco/diagnostic-languageserver). It also supports code formatting.
423
423
424
424
## Command line usage
425
425
426
-
jedi-language-server can be run directly from the command line.
426
+
`jedi-language-server` can be run directly from the command line.
427
427
428
428
```console
429
429
$ jedi-language-server --help
@@ -519,9 +519,9 @@ make tests
519
519
520
520
## Inspiration
521
521
522
-
Palantir's [python-language-server](https://github.com/palantir/python-language-server) inspired this project. In fact, for consistency's sake, many of python-language-server's CLI options are used as-is in jedi-language-server.
522
+
Palantir's [python-language-server](https://github.com/palantir/python-language-server) inspired this project. In fact, for consistency's sake, many of python-language-server's CLI options are used as-is in `jedi-language-server`.
- Uses [pygls](https://github.com/openlawlibrary/pygls) instead of creating its own low-level Language Server Protocol bindings
527
527
- Supports one powerful 3rd party static analysis / completion / refactoring library: Jedi. By only supporting Jedi, we can focus on supporting all Jedi features without exposing ourselves to too many broken 3rd party dependencies (I'm looking at you, [rope](https://github.com/python-rope/rope)).
0 commit comments