Skip to content

Commit 185233a

Browse files
committed
Update branch name in CONTRIBUTING, adjust logging and headers
1 parent 72a198d commit 185233a

File tree

1 file changed

+20
-13
lines changed

1 file changed

+20
-13
lines changed

CONTRIBUTING.md

Lines changed: 20 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,11 @@ You can contribute to the project through:
2121

2222
Thank you for all your contributions :heart:
2323

24-
[license]: https://github.com/jupyter-lsp/jupyterlab-lsp/blob/master/LICENSE
24+
[license]: https://github.com/jupyter-lsp/jupyterlab-lsp/blob/main/LICENSE
2525
[extending]: ./docs/Extending.html
2626
[roadmap]: ./docs/Roadmap.html
2727
[jupyterlab-lsp]: https://github.com/jupyter-lsp/jupyterlab-lsp.git
28-
[code-of-conduct]: https://github.com/jupyter/governance/blob/master/conduct/code_of_conduct.md
28+
[code-of-conduct]: https://github.com/jupyter/governance/blob/main/conduct/code_of_conduct.md
2929

3030
### Set up the environment
3131

@@ -52,7 +52,7 @@ pip install -r requirements/dev.txt # in a virtualenv, probably
5252
sudo apt-get install nodejs # ... e.g. on debian/ubuntu
5353
```
5454

55-
#### The Easy Way
55+
#### Single-step installation
5656

5757
Once your environment is created and activated, on Linux/OSX you can run:
5858

@@ -62,7 +62,10 @@ bash binder/postBuild
6262

6363
This performs all the basic setup steps, and is used for the binder demo.
6464

65-
#### The Hard Way
65+
This approach may not always work. Continue reading for a step-by-step
66+
instructions which also show all the underlying pieces.
67+
68+
#### Manual installation
6669

6770
Install `jupyter-lsp` from source in your virtual environment:
6871

@@ -378,25 +381,25 @@ The spec should only be advertised if the command _could actually_ be run:
378381

379382
otherwise an empty dictionary (`{}`) should be returned.
380383

381-
[built-in specs]: https://github.com/jupyter-lsp/jupyterlab-lsp/tree/master/python_packages/jupyter_lsp/jupyter_lsp/specs
382-
[setup.cfg]: https://github.com/jupyter-lsp/jupyterlab-lsp/blob/master/python_packages/jupyter_lsp/setup.cfg
383-
[schema]: https://github.com/jupyter-lsp/jupyterlab-lsp/blob/master/python_packages/jupyter_lsp/jupyter_lsp/schema/schema.json
384-
[utilities]: https://github.com/jupyter-lsp/jupyterlab-lsp/blob/master/python_packages/jupyter_lsp/jupyter_lsp/specs/utils.py
384+
[built-in specs]: https://github.com/jupyter-lsp/jupyterlab-lsp/tree/main/python_packages/jupyter_lsp/jupyter_lsp/specs
385+
[setup.cfg]: https://github.com/jupyter-lsp/jupyterlab-lsp/blob/main/python_packages/jupyter_lsp/setup.cfg
386+
[schema]: https://github.com/jupyter-lsp/jupyterlab-lsp/blob/main/python_packages/jupyter_lsp/jupyter_lsp/schema/schema.json
387+
[utilities]: https://github.com/jupyter-lsp/jupyterlab-lsp/blob/main/python_packages/jupyter_lsp/jupyter_lsp/specs/utils.py
385388

386389
##### Common Concerns
387390

388391
- some language servers need to have their connection mode specified
389392
- the `stdio` interface is the only one supported by `jupyter_lsp`
390393
- PRs welcome to support other modes!
391-
- because of its VSCode heritage, many language servers use `nodejs`
394+
- many language servers use `nodejs`
392395
- `LanguageServerManager.nodejs` will provide the location of our best
393396
guess at where a user's `nodejs` might be found
394397
- some language servers are hard to start purely from the command line
395398
- use a helper script to encapsulate some complexity, or
396-
- use a command argument of the interpreter is available (see the [r spec][] and [julia spec] for examples)
399+
- use a `command` argument of the interpreter is available (see the [r spec][] and [julia spec] for examples)
397400

398-
[r spec]: https://github.com/jupyter-lsp/jupyterlab-lsp/blob/master/python_packages/jupyter_lsp/jupyter_lsp/specs/r_languageserver.py
399-
[julia spec]: https://github.com/jupyter-lsp/jupyterlab-lsp/blob/master/python_packages/jupyter_lsp/jupyter_lsp/specs/julia_language_server.py
401+
[r spec]: https://github.com/jupyter-lsp/jupyterlab-lsp/blob/main/python_packages/jupyter_lsp/jupyter_lsp/specs/r_languageserver.py
402+
[julia spec]: https://github.com/jupyter-lsp/jupyterlab-lsp/blob/main/python_packages/jupyter_lsp/jupyter_lsp/specs/julia_language_server.py
400403

401404
##### Example: making a pip-installable `cool-language-server` spec
402405

@@ -462,7 +465,11 @@ python setup.py sdist bdist_wheel
462465

463466
## Debugging
464467

465-
Adjust `loggingLevel` in the `Advanced Settings Editor` -> `Language Server` to see more log messages.
468+
To see more see more log messages navigate to `Settings``Settings Editor``Language Servers` and adjust:
469+
470+
- adjust `Logging console verbosity level`
471+
- switch `Ask servers to send trace notifications` to `verbose`
472+
- toggle `Log all LSP communication with the LSP servers`
466473

467474
For robot tests set:
468475

0 commit comments

Comments
 (0)