Properly document hotkeys in generated documentation. #15037
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
zzmp
changed the title
| @@ -361,7 +361,7 @@ | |||
| $(document).on('keypress.searchnav', function(e) { | |||
Updated search bar to match help text. Used correct, normalized hotkeys in search. Updated shortcut menu with working shortcuts (tabs). Changed height of search help.
bors
added a commit
that referenced
this pull request
Jun 19, 2014
Continuing from #15012, this makes four changes to the `rustdoc` static files. - Change the placeholder text of the search bar to `Click or press 'S' to search, '?' for more options...` to make keyboard hotkeys more apparent (capitalizing the `S` to match the help text). - Change the `main.js` file to use browser-normalized key codes (`e.which`, from `jQuery`), instead of `e.keyCode`. - Change the key code for `?` to be the correct `191` instead of `188`, so that the hotkey works to bring up search information. - Change the search information to display `tab` and `shift+tab` instead of `up` and `down`, as those do not yet work outside of Firefox (see #15011). Also, adjust the height so it does not cut off the help text. <s>I've also opened up #15038 about the non-functional `up` and `down` functionality, although this does nothing to fix it.</s>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Continuing from #15012, this makes four changes to the
rustdocstatic files.Click or press 'S' to search, '?' for more options...to make keyboard hotkeys more apparent (capitalizing theSto match the help text).main.jsfile to use browser-normalized key codes (e.which, fromjQuery), instead ofe.keyCode.?to be the correct191instead of188, so that the hotkey works to bring up search information.tabandshift+tabinstead ofupanddown, as those do not yet work outside of Firefox (see rustdoc: Arrow keys don't always work when searching #15011). Also, adjust the height so it does not cut off the help text.I've also opened up #15038 about the non-functionalupanddownfunctionality, although this does nothing to fix it.