Skip to content

rustdoc: please show doc attribute info in search results #73922

@Lokathor

Description

@Lokathor
Contributor

When showing the main listing of functions in a module the doc attribute info is shown in front of the short function description.

However, when you use the search to filter to just functions with a particular substring, the listing of search results doesn't show that doc info. Please improve the search result display to show the additional info.

Activity

added
C-feature-requestCategory: A feature request, i.e: not implemented / a PR.
T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.
on Jul 1, 2020
GuillaumeGomez

GuillaumeGomez commented on Jul 9, 2020

@GuillaumeGomez
Member

I have issues to understand the problem here: can you provide screenshot where this is missing please?

Lokathor

Lokathor commented on Jul 9, 2020

@Lokathor
ContributorAuthor

Sure, no problem.

Screenshot 2020-07-09 06 38 01

Here, we see

  • The first part is what a function looks like in the main function listing for a module. The required arch and CPU feature are listed before the function's short description in the little blue box.
  • The second part is what the same function looks like if you use the rustdoc search and get some results. In the result listing, the extra info about arch and CPU feature are not displayed.
GuillaumeGomez

GuillaumeGomez commented on Jul 9, 2020

@GuillaumeGomez
Member

Ok I see. It would indeed be nice to have it on the search results as well. We'll try to add it there as well (don't hesitate to give it a try as well if you're interested 😄 ).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    A-rustdoc-searchArea: Rustdoc's search featureC-feature-requestCategory: A feature request, i.e: not implemented / a PR.F-doc_cfg`#![feature(doc_cfg)]`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

        Participants

        @jonas-schievink@GuillaumeGomez@Lokathor@jyn514@camelid

        Issue actions

          rustdoc: please show `doc` attribute info in search results · Issue #73922 · rust-lang/rust