Skip to content

[Feature] turn noqa: <rule> comments into hyperlinks to the docs #723

Open
@phitoduck

Description

@phitoduck

Context: I'd love for my team to learn the "why" behind the the linting rules in ruff. The docs do a beautiful job explaining them.

Suggestion:

The docs for the "why" behind the rule INP001 are at https://docs.astral.sh/ruff/rules/implicit-namespace-package/

It would be convenient if the VS Code extension turned the INP001 portion of # noqa: INP001 or # noqa: implicit-namespace-package into a clickable hyperlink to the docs page for that rule.

The docker VS Code extension does something similar in docker-compose.yaml and Dockerfile files. For example, the image: <image name> and FROM <base image> statements link to the URL for those images.

Another example is the GitHub Actions extension which turns action names into links to the docs of that GitHub action.

Metadata

Metadata

Assignees

No one assigned

    Labels

    questionAsking for support or clarification

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions