rust-lang/rust

rustdoc: please show `doc` attribute info in search results

Lokathor opened this issue · 3 comments

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.

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

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.

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 😄 ).