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

Add Tilde name to KeyCode::Grave comment #10495

Closed
wants to merge 4 commits into from

Conversation

doonv
Copy link
Contributor

@doonv doonv commented Nov 10, 2023

Objective

I had trouble finding the ` / ~ key, because I usually call it the tilde key.

Solution

Add the name Tilde to KeyCode::Grave's doc comment.

Co-authored-by: Alice Cecile <[email protected]>
@mockersf
Copy link
Member

this is not the same key on an azerty keyboard

@doonv
Copy link
Contributor Author

doonv commented Nov 10, 2023

this is not the same key on an azerty keyboard

Yes, but most people use QWERTY. This is only a small comment to help people find the ` key.

@TimJentzsch
Copy link
Contributor

Let's add a doc alias as well to make it easier to find in the search :)

@alice-i-cecile alice-i-cecile added C-Docs An addition or correction to our documentation A-Input Player input via keyboard, mouse, gamepad, and more labels Nov 12, 2023
@mockersf
Copy link
Member

mockersf commented Nov 13, 2023

Yes, but most people use QWERTY. This is only a small comment to help people find the ` key.

And it will confuse other people... Could you put the Tilde / ~. apart, and mention that it's only on qwerty keyboard then?

I've seen enough games put features behind the Tilde key which is not a real key and just doesn't work

@tim-blackbird
Copy link
Contributor

The update to winit 0.29 would make this PR obsolete. I'd take a look at the changes to keyboard input and documentation there

@Vrixyz
Copy link
Member

Vrixyz commented Nov 13, 2023

The update to winit 0.29 would make this PR obsolete. I'd take a look at the changes to keyboard input and documentation there

relevant code:
https://github.com/bevyengine/bevy/pull/8745/files#diff-249bdc151d76af3066180d266ee61c4e0138bb4cf67fe9e9e7602948d92c6b5eR133-R136

It doesn't add tilde, I'm not particularly against adding it, but from my understanding, keycodes tend to refer to the resulting qwerty key used without modifiers.

Also, that code where you want to add docs comes mostly exactly from winit, so I'd be more confortable with keeping an exact copy as much as possible, and upstream any differences within winit to keep differences to a minimum.

@doonv
Copy link
Contributor Author

doonv commented Nov 13, 2023

The update to winit 0.29 would make this PR obsolete...

So should I close this? or do something else?

@alice-i-cecile
Copy link
Member

Let's close this out: I don't think we're going to have a release where it ships.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-Input Player input via keyboard, mouse, gamepad, and more C-Docs An addition or correction to our documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants