Skip to content

[website]: Add structured metadata to rules, e.g. to indicate which version a rule was introduced in #19365

Open
@corneliusroemer

Description

@corneliusroemer

Turning this comment into a separate issue:

On a similar note I have multiple times tried to figure out in which specific version of ruff that a rule was introduced or modified (bugfix, "upgraded" from nursery/preview to stable rule).

Having versioned documentation or some version information in each rule's docpage would make this much easier than today.

Originally posted by @kaddkaka in #9507

I concur this would be nice. Rust's Clippy does this really well:

Image

https://rust-lang.github.io/rust-clippy/stable/index.html

I would also appreciate (structured) metadata being shown in docs, such as version a rule was introduced in.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions