Prevent corrections and completions in search field #20381
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
In particular mobile browsers use correction mechanisms on input fields. Search will often be done with technical terms or even class/method/etc names that these correction mechanisms do not know, resulting in unwanted changes. This PR deactivates these correction mechanisms. I've also reported this upstream to sphinx at sphinx-doc/sphinx#9307. See there for more background. Our current theme uses customized templates, so we have to adapt this ourselves. You can also that this is working by accessing the CI built docs with a mobile device, and compare that with the released docs.
QuLogic
approved these changes
Jun 7, 2021
meeseeksmachine
pushed a commit
to meeseeksmachine/matplotlib
that referenced
this pull request
Jun 7, 2021
meeseeksmachine
pushed a commit
to meeseeksmachine/matplotlib
that referenced
this pull request
Jun 7, 2021
QuLogic
added a commit
that referenced
this pull request
Jun 7, 2021
…381-on-v3.4.x Backport PR #20381 on branch v3.4.x (Prevent corrections and completions in search field)
QuLogic
added a commit
that referenced
this pull request
Jun 8, 2021
…381-on-v3.4.2-doc Backport PR #20381 on branch v3.4.2-doc (Prevent corrections and completions in search field)
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.
In particular mobile browsers use correction mechanisms on input fields. Search will often be done with technical terms or even class/method/etc names that these correction mechanisms do not know, resulting in unwanted changes. This PR deactivates these correction mechanisms.
I've also reported this upstream to sphinx at sphinx-doc/sphinx#9307. See there for more background.
Our current theme uses customized templates, so we have to adapt this ourselves.
You can check that this is working by accessing the CI built docs with a mobile device, and compare that with the released docs.
Note: I know the theme may be changing in the near future. But even if this does not make it to a release, it would be a win for me. I often quickly search the dev-docs on mobile when responding to an issue and correction drives me nuts.