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]: Explain what ESC does in the help box #82474

Closed
tesuji opened this issue Feb 24, 2021 · 4 comments
Closed

[rustdoc]: Explain what ESC does in the help box #82474

tesuji opened this issue Feb 24, 2021 · 4 comments
Assignees
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools A-rustdoc-ui Area: Rustdoc UI (generated HTML) 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

@tesuji
Copy link
Contributor

tesuji commented Feb 24, 2021

I think we could include a text to explain what ESC does after #82234 merged.
image

This helps increasing popularity of the feature. Also, should we need to tag relnotes for the above PR ?

@rustbot rustbot added A-rustdoc-ui Area: Rustdoc UI (generated HTML) S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. and removed S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. labels Feb 24, 2021
@jyn514 jyn514 added 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 Feb 24, 2021
@jyn514
Copy link
Member

jyn514 commented Feb 24, 2021

Mentoring instructions: Add an entry for esc in

var shortcuts = [
["?", "Show this help dialog"],
["S", "Focus the search field"],
["T", "Focus the theme picker menu"],
["↑", "Move up in search results"],
["↓", "Move down in search results"],
["ctrl + ↑ / ↓", "Switch result tab"],
["⏎", "Go to active search result"],
["+", "Expand all sections"],
["-", "Collapse all sections"],
].map(function(x) {

@jyn514 jyn514 added the E-mentor Call for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion. label Feb 24, 2021
@camelid camelid added the C-enhancement Category: An issue proposing an enhancement or a PR with one. label Feb 25, 2021
@TaKO8Ki
Copy link
Member

TaKO8Ki commented Feb 25, 2021

I'm interested in working on this issue!
@rustbot claim

@TaKO8Ki
Copy link
Member

TaKO8Ki commented Mar 1, 2021

close this issue because esc doesn't do anything out of the ordinary. ref #82522 (comment)

@TaKO8Ki
Copy link
Member

TaKO8Ki commented Mar 1, 2021

@jyn514
Could you close this issue?

@jyn514 jyn514 closed this as completed Mar 1, 2021
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-rustdoc-ui Area: Rustdoc UI (generated HTML) 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

Successfully merging a pull request may close this issue.

5 participants