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

Document type-based search #75197

Closed
jyn514 opened this issue Aug 5, 2020 · 11 comments
Closed

Document type-based search #75197

jyn514 opened this issue Aug 5, 2020 · 11 comments
Labels
A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools A-type-based-search Area: Searching rustdoc pages using type signatures C-enhancement Category: An issue proposing an enhancement or a PR with one. E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. E-mentor Call for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@jyn514
Copy link
Member

jyn514 commented Aug 5, 2020

I find this really useful, but it's very difficult to find information on it anywhere.

Example of type-based search: https://users.rust-lang.org/t/a-year-in-rust-and-i-still-cant-read-the-docs/46872/20

@jyn514 jyn514 added T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. C-enhancement Category: An issue proposing an enhancement or a PR with one. A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. labels Aug 5, 2020
@jyn514
Copy link
Member Author

jyn514 commented Aug 5, 2020

This would be a good first issue. The documentation should go somewhere in https://github.com/rust-lang/rust/tree/master/src/doc/rustdoc/src.

@jyn514 jyn514 added the E-mentor Call for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion. label Aug 5, 2020
@ThePuzzlemaker
Copy link
Contributor

@rustbot claim

@ThePuzzlemaker
Copy link
Contributor

I'll look into any other obscure search features like this, and be sure to document them. (I'll be sure to document at least this one)

@ThePuzzlemaker
Copy link
Contributor

image
@jyn514 I've actually found that this feature is documented in the "Search Tricks" section of the help dialog.

@ThePuzzlemaker
Copy link
Contributor

And I don't find that it would really be helpful to document this in the rustdoc book as it's more of an emitted feature rather than a rustdoc feature itself. If it wasn't added to the search tricks already, I would add it there.
@rustbot release-assignment

@ThePuzzlemaker
Copy link
Contributor

I feel that the help dialog is already easy to find enough, though the for more options... might be disambiguated to for help... or something like that.
image

@jyn514
Copy link
Member Author

jyn514 commented Aug 8, 2020

Hmm that does seem simple enough but I never found it after a year in rust ... cc @rust-lang/rustdoc, does anyone have ideas how to make this more discoverable?

@GuillaumeGomez
Copy link
Member

It's true that it's hard to find it, maybe we should add a ? button that would also show the popup alongside the search input?

@ThePuzzlemaker
Copy link
Contributor

That makes sense, as the settings and theme dropdown are triggered by buttons rather than keyboard shortcuts.

@GuillaumeGomez
Copy link
Member

Ok, I'll send a PR tomorrow to add the button then.

@jyn514
Copy link
Member Author

jyn514 commented Aug 17, 2020

Closing since #75366 is merged, hopefully that will make this easier to find.

@jyn514 jyn514 closed this as completed Aug 17, 2020
@jyn514 jyn514 added the A-type-based-search Area: Searching rustdoc pages using type signatures label Aug 17, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools A-type-based-search Area: Searching rustdoc pages using type signatures C-enhancement Category: An issue proposing an enhancement or a PR with one. E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. E-mentor Call for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion. 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

3 participants