Skip to content

Commit 2c57055

Browse files
committed
linting, update advanced installing example versions, fix typos and formatting
1 parent c9051ce commit 2c57055

File tree

3 files changed

+30
-24
lines changed

3 files changed

+30
-24
lines changed

docs/Installation.ipynb

Lines changed: 27 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -15,21 +15,27 @@
1515
"\n",
1616
"Delivering LSP features to your JupyterLab **requires** three pieces:\n",
1717
"\n",
18-
"- `jupyter_lsp`\n",
19-
" - runs in your `notebook` web application on your server\n",
20-
" - to run, you need:\n",
21-
" - `python >=3.5`\n",
22-
" - `notebook >=4.3`\n",
23-
"- `jupyterlab-lsp`\n",
24-
" - runs in your browser\n",
25-
" - to install it, you need:\n",
26-
" - `nodejs >8`\n",
27-
" - `jupyterlab >=1.1,<2`\n",
28-
"- one or more language servers\n",
29-
" - run on your server\n",
30-
" - some can be automatically [detected](./Language%20Servers.ipynb) if\n",
31-
" installed\n",
32-
" - others also need to be [configured](./Configuring.ipynb#language_servers)"
18+
"#### `jupyter_lsp`\n",
19+
"\n",
20+
"- runs in your `notebook` web application on your server to handle requests from\n",
21+
" the browser to _language servers_\n",
22+
"- to run, you need:\n",
23+
" - `python >=3.5`\n",
24+
" - `notebook >=4.3`\n",
25+
"\n",
26+
"#### `jupyterlab-lsp`\n",
27+
"\n",
28+
"- runs in your browser, as an extension to JupyterLab\n",
29+
"- to install it, you need:\n",
30+
" - `nodejs >8`\n",
31+
" - `jupyterlab >=1.1,<2`\n",
32+
"\n",
33+
"#### Language Servers\n",
34+
"\n",
35+
"- run on your server,\n",
36+
" - probably in another language runtime than python\n",
37+
"- some can be automatically [detected](./Language%20Servers.ipynb) if installed\n",
38+
"- others also need to be [configured](./Configuring.ipynb#language_servers)"
3339
]
3440
},
3541
{
@@ -49,11 +55,11 @@
4955
"#### conda (minimal python)\n",
5056
"\n",
5157
"```bash\n",
52-
"conda create -c conda-forge -n lsp 'python >=3.7,<3.8' 'jupyterlab=1.2' 'nodejs=11' python-language-server\n",
58+
"conda create -c conda-forge -n lsp 'python >=3.7,<3.8' 'jupyterlab=1.2' 'nodejs>8' python-language-server\n",
5359
"# Also consider: r-languageserver [*]\n",
5460
"source activate lsp\n",
55-
"python -m pip install 'jupyter_lsp=0.7' --no-deps\n",
56-
"jupyter labextension install '@krassowski/jupyterlab-lsp@0.7.1'\n",
61+
"python -m pip install 'jupyter_lsp=0.8.0' --no-deps\n",
62+
"jupyter labextension install '@krassowski/jupyterlab-lsp@0.8.0'\n",
5763
"```\n",
5864
"\n",
5965
"Then run\n",
@@ -91,9 +97,9 @@
9197
" 'python-language-server' \\\n",
9298
" 'r-languageserver' \\\n",
9399
" && python3 -m pip install --no-cache-dir --no-deps \\\n",
94-
" 'jupyter_lsp==0.7' \\\n",
100+
" 'jupyter_lsp==0.8.0' \\\n",
95101
" && jupyter labextension install --no-build \\\n",
96-
" '@krassowski/jupyterlab-lsp@0.7.1' \\\n",
102+
" '@krassowski/jupyterlab-lsp@0.8.0' \\\n",
97103
" && jupyter lab build --dev-build=False --minimize=True \\\n",
98104
" && conda clean --all -f -y \\\n",
99105
" && rm -rf \\\n",
@@ -202,7 +208,7 @@
202208
"\n",
203209
"```bash\n",
204210
"pip install jupyter_lsp\n",
205-
"jupyter labextension install @krassowitz/jupyterlab-lsp\n",
211+
"jupyter labextension install @krassowski/jupyterlab-lsp\n",
206212
"```"
207213
]
208214
},

docs/Releasing.ipynb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@
2222
"python scripts/integrity.py\n",
2323
"```\n",
2424
"\n",
25-
"> TODO: create a `release.py` script\n",
26-
"> [#88](https://github.com/krassowski/jupyterlab-lsp/issues/88)\n",
25+
"- TODO: create a `release.py` script\n",
26+
" [#88](https://github.com/krassowski/jupyterlab-lsp/issues/88)\n",
2727
"\n",
2828
"The PyPI version must be updated in the following places:\n",
2929
"\n",

py_src/jupyter_lsp/specs/utils.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ def __call__(self, mgr: LanguageServerManagerAPI) -> KeyedLanguageServerSpecs:
4545
if cmd:
4646
break
4747

48-
if not cmd and BUILDING_DOCS: # pragma: no cover
48+
if not cmd and BUILDING_DOCS: # pragma: no cover
4949
cmd = self.cmd
5050

5151
if not cmd: # pragma: no cover

0 commit comments

Comments
 (0)