Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

outdated README- shipped ruff and Jupyter Notebooks support in native server #590

Closed
hryniewskis opened this issue Aug 21, 2024 · 0 comments · Fixed by #591
Closed

outdated README- shipped ruff and Jupyter Notebooks support in native server #590

hryniewskis opened this issue Aug 21, 2024 · 0 comments · Fixed by #591

Comments

@hryniewskis
Copy link
Contributor

Hi,
as stated in the title, the README section about support for Jupyter Notebooks in the Native server is outdated (and at least, in my opinion, a bit confusing).

ruff-vscode/README.md

Lines 71 to 85 in 7f9ea75

### Native Server
The native server supports Jupyter Notebooks out of the box. Unlike `ruff-lsp`, the native server requires
the user to explicitly include Jupyter Notebooks in the set of files to lint and format. This can be done by
updating the [`extend-include`](https://docs.astral.sh/ruff/settings/#extend-include) setting in the Ruff configuration file.
```toml
[tool.ruff]
extend-include = ["*.ipynb"]
```
Refer to the [Jupyter Notebook discovery](https://docs.astral.sh/ruff/configuration/#jupyter-notebook-discovery) section
of the Ruff documentation for more information.
[notebook document synchronization]: https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#notebookDocument_synchronization

Also, the version of Ruff, the extension is shipped with, is wrong

The extension ships with `ruff==0.5.7`.

According to the source code, the extension in version 2024.42.0 is shipped with ruff==0.6.1. Ruff, since 0.6.0 version supports linting and formatting Jupyter Notebooks by default (source: blog post). This also means that the native server in Ruff extension provides Jupyter Notebook Support out-of-the-box.

I will soon make a new merge request for a README update in these two places

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant