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

Display Documentation/Link to Rules #425

Open
stevin-wilson opened this issue Apr 17, 2024 · 1 comment
Open

Display Documentation/Link to Rules #425

stevin-wilson opened this issue Apr 17, 2024 · 1 comment
Labels
enhancement New feature or request

Comments

@stevin-wilson
Copy link

stevin-wilson commented Apr 17, 2024

Is your feature request related to a problem? Please describe.
First of all, Thanks for the wonderful tool!

Is there a way to show the documentation (preferred) or link for the rule along with the tooltip?

For example, could the documentation for rule T201 be accessed from the tooltip in the attached screenshot?

Screenshot 2024-04-17 at 10 24 28 AM

Describe the solution you'd like

It would be very helpful if the documentation (including "use instead" information) can be displayed in the tooltip.
Screenshot 2024-04-17 at 12 17 26 PM

Another option is to include a link to webpage containing the documentation for the rule as described in astral-sh/ruff-lsp#163 (comment)

Additional context

@koxudaxi koxudaxi added the enhancement New feature or request label Apr 20, 2024
@koxudaxi
Copy link
Owner

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

No branches or pull requests

2 participants