Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
Lokathor opened this issue Jul 1, 2020 · 3 comments
Open

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

Lokathor opened this issue Jul 1, 2020 · 3 comments
Labels
A-rustdoc-search Area: Rustdoc's search feature C-feature-request Category: A feature request, i.e: not implemented / a PR. F-doc_cfg `#![feature(doc_cfg)]` T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@Lokathor
Copy link
Contributor

Lokathor commented Jul 1, 2020

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.

@jonas-schievink jonas-schievink added C-feature-request Category: A feature request, i.e: not implemented / a PR. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. labels Jul 1, 2020
@GuillaumeGomez
Copy link
Member

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

@Lokathor
Copy link
Contributor Author

Lokathor commented Jul 9, 2020

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
Copy link
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
Labels
A-rustdoc-search Area: Rustdoc's search feature C-feature-request Category: A feature request, i.e: not implemented / a PR. F-doc_cfg `#![feature(doc_cfg)]` T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Development

No branches or pull requests

5 participants