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.

Sign up for GitHub

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

Jump to bottom

rustdoc: confusing use of "type" #75623

Closed
RalfJung opened this issue Aug 17, 2020 · 1 comment · Fixed by #75976
Closed

rustdoc: confusing use of "type" #75623

RalfJung opened this issue Aug 17, 2020 · 1 comment · Fixed by #75976
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 T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@RalfJung
Copy link
Member

The rustdoc help says

Prefix searches with a type followed by a colon (e.g., fn:) to restrict the search to a given type.

Accepted types are: fn, mod, struct, enum, trait, type, macro, and const.

However, in Rust lingo, struct or enum isn't a "type". Vec<i32> is a type. And macro, trait and const certainly aren't "types".

IMO this should at least be qualified to something like "item type", but I think "item kind" would be even better.
@RalfJung
Copy link
Member Author

Cc @rust-lang/rustdoc

@jyn514 jyn514 added A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. labels Aug 17, 2020
@jyn514 jyn514 added the A-type-based-search Area: Searching rustdoc pages using type signatures label Aug 25, 2020
@GuillaumeGomez GuillaumeGomez mentioned this issue Aug 27, 2020
Merged
Dylan-DPC-zz pushed a commit to Dylan-DPC-zz/rust that referenced this issue Aug 27, 2020
@Dylan-DPC
Rollup merge of rust-lang#75976 - GuillaumeGomez:help-popup, r=jyn514
72c8fb4 
Improve help popup

Fixes rust-lang#75623.

The second commit is just a slight improvement: the help popup won't be created until someone presses "?" or ESC. Not a big improvement in itself but considering the low amount of code required, I think it was worth the shot.

r? @jyn514
@bors bors closed this as completed in 397b390 Aug 27, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
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 T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Improve help popup GuillaumeGomez/rust
2 participants
@RalfJung @jyn514