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

Include page title in the API search result #24062

Closed
mhristache opened this issue Apr 4, 2015 · 5 comments
Closed

Include page title in the API search result #24062

mhristache opened this issue Apr 4, 2015 · 5 comments
Labels
C-feature-request Category: A feature request, i.e: not implemented / a PR. T-dev-tools Relevant to the dev-tools subteam, which will review and decide on the PR/issue. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@mhristache
Copy link

The API doc search is not very user friendly as the results only include a description of each result entry. The description is most of the time very generic, e.g. it's hard to know when the search result points to a module doc, or to a primitive or whatever.

See the screen shot below, the first result is pointing to the str module doc, which is not very helpful IMHO. The helpful result is the 4th one (the str primitive doc) but it's impossible to know that without going thru each result.

screen shot 2015-04-04 at 12 56 59

I think the search results should include the title of the page which will make it possible to easily find the wanted page.

@steveklabnik steveklabnik added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Apr 4, 2015
@tomjakubowski
Copy link
Contributor

The final segment of each path is color coded, but yeah there's not really a way to know which color is which other than by experience.

@steveklabnik
Copy link
Member

Triage: no change

@steveklabnik steveklabnik added T-dev-tools Relevant to the dev-tools subteam, which will review and decide on the PR/issue. and removed T-tools labels May 18, 2017
@Mark-Simulacrum Mark-Simulacrum added the C-feature-request Category: A feature request, i.e: not implemented / a PR. label Jul 22, 2017
@steveklabnik
Copy link
Member

Triage: the page titles are even more generic, they just have the type name in them.

There has been no change, but I wonder if this is something we want to fix, really. Maybe it comes down to writing better summaries. (Also, note that the str primitive type is first nowadays.)

@jsha
Copy link
Contributor

jsha commented Jun 3, 2021

Search results now show str (primitive), and color code different types of results: in the light theme, blue for modules, purple for structs, and orange for fns (not all colors listed here). @mhristache does this solve the issue for you?

image

@mhristache
Copy link
Author

I guess it does. Thanks for the improvements!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-feature-request Category: A feature request, i.e: not implemented / a PR. T-dev-tools Relevant to the dev-tools subteam, which will review and decide on the PR/issue. 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