Skip to content

Rustdoc: group items by stability, rather than alphabetically #15345

Closed
@bstrie

Description

@bstrie

Rustdoc has grown a lovely new feature whereby index pages with listings of functions and types will display a color next to each item indicating whether it's experimental, unstable, stable, or deprecated. I would like to go one further: group all items according to stability, rather than just having them scattered through an alphabetic list. After grouping by stability, I would like each of the four sections to be ordered as follows:

  1. Stable
  2. Unstable
  3. Experimental
  4. Deprecated

Within each group, ordering will remain alphabetical.

Reasoning: if I'm a user, I want to prefer stable items, which means that I want to see at a glance what my stable options are. If there are no stable options, then I want to consider unstable options, then experimental options, then deprecated options, in that order. Furthermore, if I'm a library author, then I want my users to consider options in the same order: stable first, then unstable-but-up-and-coming, then deprecated last.

Metadata

Metadata

Assignees

No one assigned

    Labels

    C-enhancementCategory: An issue proposing an enhancement or a PR with one.T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions