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

Docs searchbox shortcut formatted wrong on Mac #1960

Open
medmunds opened this issue Feb 25, 2025 · 0 comments · May be fixed by #1961
Open

Docs searchbox shortcut formatted wrong on Mac #1960

medmunds opened this issue Feb 25, 2025 · 0 comments · May be fixed by #1961

Comments

@medmunds
Copy link

(This is a minor nit, but I didn't want to open a PR without a matching issue.)

In the documentation site searchbox, the placeholder currently displays its shortcut as "(⌘ + K)" on macOS and "(Ctrl + K)" elsewhere.

Using "+" like that is very much a Windows convention. Macs use just the key symbol without a plus sign: "⌘ K".

Mac (Safari):
Screenshot of Mac Safari on docs.djangoproject.com, highlighting shortcut keys in the Edit menu shown without plus signs, and the ⌘ + K shortcut shown in the site's searchbox

Windows (Edge):
Screenshot of Windows Edge on docs.djangoproject.com, highlighting shortcut keys in the three-dot menu shown with plus signs, and the Ctrl + K) shown in the site's searchbox

(Also, Windows apps don't typically use spaces around the plus sign: "Ctrl+K".)
@medmunds medmunds mentioned this issue Feb 25, 2025
Merged
medmunds added a commit to medmunds/djangoproject.com that referenced this issue Feb 25, 2025
@medmunds
Followed platform conventions for showing search shortcut key
43d09c8 
Changed display of the search shortcut key to "⌘ K" on Mac and "Ctrl+K" elsewhere.

Fixes django#1960.
@medmunds medmunds linked a pull request Feb 25, 2025 that will close this issue
Open
medmunds added a commit to medmunds/djangoproject.com that referenced this issue Feb 25, 2025
@medmunds
Followed platform conventions for showing search shortcut key
2bf34eb 
Changed display of the search shortcut key to "⌘ K" on Mac and "Ctrl+K" elsewhere.

(\u200a is a hair space, which looks better than a full space or no space.)

Fixes django#1960.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Followed platform conventions for showing search shortcut key medmunds/djangoproject.com
1 participant
@medmunds