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

Update to reflect the stabilized ruff server #531

Merged
merged 2 commits into from
Jul 18, 2024
Merged

Conversation

dhruvmanila
Copy link
Member

@dhruvmanila dhruvmanila commented Jul 17, 2024

Summary

This PR updates the README to reflect the stabilized ruff server. It also changes the minimum required version for the usage of ruff server in nativeServer: auto to be 0.5.3.

For the README, the settings that are just a pass through to the native server are removed and instead we point the users to the online settings reference. Now, the settings table only contains the ones which are specific to VS Code extension.

For review, here's the rendered README: https://github.com/astral-sh/ruff-vscode/blob/dhruv/readme/README.md

resolves: #520

@dhruvmanila dhruvmanila force-pushed the dhruv/readme branch 2 times, most recently from 8a696d8 to ac08069 Compare July 17, 2024 02:35
@dhruvmanila dhruvmanila changed the title Update README to reflect the stabilized ruff server Update to reflect the stabilized ruff server Jul 17, 2024
@dhruvmanila dhruvmanila marked this pull request as ready for review July 17, 2024 02:39
Copy link
Member

@MichaReiser MichaReiser left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Let's wait for @charliermarsh I think he wants to do the final approval.

Should we add a sentence saying that whether ruff-lsp or ruff server is used, can be seen in the toolbar?

README.md Outdated Show resolved Hide resolved
@dhruvmanila
Copy link
Member Author

dhruvmanila commented Jul 17, 2024

Should we add a sentence saying that whether ruff-lsp or ruff server is used, can be seen in the toolbar?

Good idea. I'll add a "Troubleshooting" section because I don't think it's present in the toolbar by default.

Edit: Added a troubleshooting section in #533

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@dhruvmanila dhruvmanila merged commit 47de9ee into main Jul 18, 2024
6 checks passed
@dhruvmanila dhruvmanila deleted the dhruv/readme branch July 18, 2024 05:19
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 this pull request may close these issues.

Update Ruff version when the server is stabilized
3 participants