Skip to content

[website] Search preview snippets should always show "What it does" instead of "Where it derives from" #19374

Open
@corneliusroemer

Description

@corneliusroemer

I came across non-ideal behavior of the search modal while looking for a Ruff lint rule that would flag Exceptions without any message text.

I noticed that the search preview snippets weren't as useful as they could be. All the snippets mention where the rule comes from. But I don't care about that. I want to know "What it does". That information is available, it's just not shown above the fold by default.

Feature request: make "What it does" be the number one thing in preview snippets.

See the default snippets (without having clicked anything):

Image

The actually relevant summary only shows when I click on "2 more on this page":

Image

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