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

Replace "alt" with "opt" for macOS shortcuts #8932

Merged
merged 1 commit into from
Mar 10, 2024

Conversation

skyace65
Copy link
Contributor

@skyace65 skyace65 commented Feb 9, 2024

In the past Mac keyboards would have "alt" written on the option key in addition to "option", these days it's just "option". I'm using "Opt" instead of "Option" for these based on discussions with bruvzg in rocket chat. Closes #7959.

@skyace65 skyace65 added enhancement area:getting started Issues and PRs related to the Getting Started section of the documentation area:manual Issues and PRs related to the Manual/Tutorials section of the documentation cherrypick:4.2 labels Feb 9, 2024
@frederickjjoubert
Copy link

As a Mac user, I agree with this PR. The key is labeled as "option" on my keyboard.

@menaechmi
Copy link

I couldn't find any references to a macOS Alt that weren't included in this PR.

If accepted, should this line in the Docs Writing Guidelines also be changed along to "On macOS, Cmd often replaces Ctrl in keyboard shortcuts and Opt replaces Alt in keyboard shortcuts." ?

Make sure to mention shortcuts that differ on macOS compared to other platforms.
On macOS, ``Cmd`` often replaces ``Ctrl`` in keyboard shortcuts.

@skyace65
Copy link
Contributor Author

I couldn't find any references to a macOS Alt that weren't included in this PR.

If accepted, should this line in the Docs Writing Guidelines also be changed along to "On macOS, Cmd often replaces Ctrl in keyboard shortcuts and Opt replaces Alt in keyboard shortcuts." ?

Make sure to mention shortcuts that differ on macOS compared to other platforms.
On macOS, ``Cmd`` often replaces ``Ctrl`` in keyboard shortcuts.

I think it would make more sense to just link to the shortcut page from there.

@skyace65
Copy link
Contributor Author

I've updated this PR so the doc writing guidelines just link to the keyboard shortcut page.

@edmundito
Copy link

@skyace65 thanks for pointing this out and I see that we both ran into the same confusion! My only recommendation is to reorder the mac keys based on the order of the keyboard, so instead of Cmd + Opt, it's Opt + Cmd since this is what the physical order of the keys are, how a user would press the keys in order, and also how the menus order the shortcut.

@mhilbrunner
Copy link
Member

Indeed, Apple seems to list Opt first: https://support.apple.com/en-us/HT201236

@skyace65
Copy link
Contributor Author

skyace65 commented Mar 1, 2024

Indeed, Apple seems to list Opt first: https://support.apple.com/en-us/HT201236

Fixed.

@fire
Copy link
Member

fire commented Mar 5, 2024

I'm interested in testing this, but can you rebase?

My mac keyboard is:

image

@skyace65
Copy link
Contributor Author

skyace65 commented Mar 6, 2024

I'm interested in testing this, but can you rebase?

My mac keyboard is:

image

Rebased.

@akien-mga akien-mga requested a review from bruvzg March 6, 2024 14:04
Copy link
Member

@mhilbrunner mhilbrunner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good to me and seems to make sense, formatting looks good, I did not check every shortcut and am also not often using a Mac though, so if someone using Mac as their daily driver could review, this would be great.

Copy link
Member

@fire fire left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I did not go through every shortcut, but as seen in my keyboard photo you can see that the keyboard does not say alt but option. So it looks good to me.

@mhilbrunner mhilbrunner merged commit 43bcea0 into godotengine:master Mar 10, 2024
1 check passed
@mhilbrunner
Copy link
Member

Merged! Thanks you.

@mhilbrunner
Copy link
Member

Cherry-picked to 4.2 in #9648.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:getting started Issues and PRs related to the Getting Started section of the documentation area:manual Issues and PRs related to the Manual/Tutorials section of the documentation enhancement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation references pressing Alt + Space on macOS, but there is no Alt button on Macs
6 participants