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

Provide a way to disable rustdoc keyboard shortcuts #65211

Closed
Manishearth opened this issue Oct 8, 2019 · 5 comments · Fixed by #65656
Closed

Provide a way to disable rustdoc keyboard shortcuts #65211

Manishearth opened this issue Oct 8, 2019 · 5 comments · Fixed by #65656
Assignees
Labels
T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@Manishearth
Copy link
Member

Some people have custom OS or browser-level shortcuts, providing a way to disable these makes it easier for them

@Manishearth Manishearth added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Oct 8, 2019
@GuillaumeGomez
Copy link
Member

I can add a setting for it if you want. But do we want to disable all keyboard shortcuts or only a few of them? For example, I doubt that 'S' is conflicting in any layout (but I might be wrong!).

@Manishearth
Copy link
Member Author

This isn't about layouts, this is about custom shortcuts. So yes, disable all of them.

@GuillaumeGomez
Copy link
Member

But then some features won't be accessible anymore (well, I doubt that the '?' menu would interest people who don't care about provided shortcuts). Also, should we keep the text of the search bar as is even though the shortcuts are disabled?

@Mark-Simulacrum
Copy link
Member

I think not referring to the shortcuts when they are disabled makes sense; a single button is sufficient IMO as Manish said. If features aren't available without the shortcut, that seems a bit weird, but I'd need a list of such features since I can't think of any other than ? which is obviously useless if shortcuts are off.

Gmail, for example, provides a single button (https://support.google.com/mail/answer/6594?hl=en).

@GuillaumeGomez
Copy link
Member

Well then, I'll add the option and not change anything else then.

@GuillaumeGomez GuillaumeGomez self-assigned this Oct 18, 2019
JohnTitor added a commit to JohnTitor/rust that referenced this issue Oct 22, 2019
…cut, r=Dylan-DPC

Add option to disable keyboard shortcuts in docs

Fixes rust-lang#65211.

r? @Manishearth
@bors bors closed this as completed in 88e3ae2 Oct 23, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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.

3 participants