Repository navigation
Clarify documentation and correct stale guidance - #29374
Conversation
zanieb
added
the
documentation
|
A self-review of this looks pretty good to me, some stuff is 50-50 but it also fixes various mistakes |
ntBre
left a comment
ntBre
left a comment
There was a problem hiding this comment.
Nice! Looks great to me, just a few nits/ideas for your consideration.
| The server provides Ruff diagnostics, Code Actions to fix them, and formatting using Ruff's built-in | ||
| formatter. Currently, it is intended to be used alongside another Python Language Server for | ||
| features like navigation and autocompletion. |
There was a problem hiding this comment.
Maybe we could recommend ty while we're here?
| [`ruff-lsp`][ruff-lsp] is a [Language Server Protocol] implementation that powers Ruff's editor | ||
| integrations. It is written in Python and is a separate package from Ruff itself. The **native |
There was a problem hiding this comment.
Maybe some past tense here now that we've fully dropped support?
| **Default value**: `null` | ||
|
|
||
| **Type**: `string` | ||
| **Type**: `string | object` |
There was a problem hiding this comment.
This might be technically true, but it doesn't strike me as particularly helpful.
| Ruff uses a [custom versioning scheme](https://docs.astral.sh/ruff/versioning/). Breaking changes | ||
| generally require a minor release. Patch releases can include bug fixes, backwards-compatible | ||
| additions, and preview changes. |
There was a problem hiding this comment.
We still generally follow semver right? Linking to our versioning directly also makes sense, though.
There was a problem hiding this comment.
I'm not sure why it changed this file tbh, maybe I'll see what we say in uv
| **Default value**: `null` | ||
|
|
||
| **Type**: `string | object` | ||
| **Type**: `string` (path to a configuration file) or `object` (inline configuration) |
There was a problem hiding this comment.
Oh, maybe this does kind of make sense. I didn't really understand the full context from the diff, but you really can provide either a path or a whole configuration object.
string | object or even this longer version seems okay to me now.
https://docs.astral.sh/ruff/editors/settings/#configuration_resolution_order
The documentation has stale configuration guidance and a few examples that do not work as written. Clarify the prose and correct editor configuration precedence, user-level configuration discovery, rule descriptions, and the tutorial and configuration examples.