Set the diagnostic URL for lint errors #21514
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Summary -- This PR wires up the `Diagnostic::set_documentation_url` method from #21502 to Ruff's lint diagnostics and renders them in the grouped output format (concise and full are already covered by #21502). I considered also including the URLs for the pylint output format, but it doesn't currently render any color in the CLI, so it may be a machine-readable format too? Test Plan --
MichaReiser
reviewed
Nov 18, 2025
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR wires up the
Diagnostic::set_documentation_urlmethod from #21502 to Ruff's lint diagnostics. This enables the links for the full and concise output formats without any other changes.I considered also including the URLs for the grouped and pylint output formats, but the grouped format is still in
ruff_linterinstead ofruff_db, so we'd have to export some additional functionality to wire it up withfmt_with_hyperlink; and the pylint format doesn't currently render with color, so I think it might actually be machine readable rather than human readable?The other ouput formats (json, json-lines, junit, github, gitlab, rdjson, azure, sarif) seem more clearly not to need the links.
Test Plan
I guess you can't see my cursor or the browser opening, but it works for lint rules, which have links, and doesn't include a link for syntax errors, which don't have valid links.