Skip to content

[Merged by Bors] - Update keyboard.rs docs in bevy_input#4517

Closed
ghost wants to merge 6 commits intomainfrom
unknown repository
Closed

[Merged by Bors] - Update keyboard.rs docs in bevy_input#4517
ghost wants to merge 6 commits intomainfrom
unknown repository

Conversation

@ghost
Copy link

@ghost ghost commented Apr 18, 2022

Objective

Solution

  • Document keyboard.rs inside of bevy_input.

@github-actions github-actions bot added the S-Needs-Triage This issue needs to be labelled label Apr 18, 2022
@ghost ghost added C-Docs An addition or correction to our documentation A-Input Player input via keyboard, mouse, gamepad, and more and removed S-Needs-Triage This issue needs to be labelled labels Apr 18, 2022
@ghost ghost changed the title Update keyboard.rs docs Update keyboard.rs docs in bevy_input Apr 18, 2022
@alice-i-cecile
Copy link
Member

@bevyengine/docs-team can I get another set of eyes on this?

@tim-blackbird
Copy link
Contributor

Not a fan of "__ key, next to __". Seems unnecessary, and it assumes the reader has a 'standard' keyboard layout.
It works out for my desktop's keyboard but, it does not match my laptop's keyboard.

@alice-i-cecile
Copy link
Member

Yeah, that's sensible. Perhaps "distinct from Num0" is more helpful?

@alice-i-cecile alice-i-cecile added the S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it label May 17, 2022
@alice-i-cecile
Copy link
Member

bors r+

bors bot pushed a commit that referenced this pull request May 17, 2022
# Objective

- Part of the splitting process of #3692.

## Solution

- Document `keyboard.rs` inside of `bevy_input`.

Co-authored-by: KDecay <KDecayMusic@protonmail.com>
@bors bors bot changed the title Update keyboard.rs docs in bevy_input [Merged by Bors] - Update keyboard.rs docs in bevy_input May 17, 2022
@bors bors bot closed this May 17, 2022
robtfm pushed a commit to robtfm/bevy that referenced this pull request May 17, 2022
# Objective

- Part of the splitting process of bevyengine#3692.

## Solution

- Document `keyboard.rs` inside of `bevy_input`.

Co-authored-by: KDecay <KDecayMusic@protonmail.com>
exjam pushed a commit to exjam/bevy that referenced this pull request May 22, 2022
# Objective

- Part of the splitting process of bevyengine#3692.

## Solution

- Document `keyboard.rs` inside of `bevy_input`.

Co-authored-by: KDecay <KDecayMusic@protonmail.com>
@ghost ghost deleted the update_keyboard_docs branch August 7, 2022 08:27
ItsDoot pushed a commit to ItsDoot/bevy that referenced this pull request Feb 1, 2023
# Objective

- Part of the splitting process of bevyengine#3692.

## Solution

- Document `keyboard.rs` inside of `bevy_input`.

Co-authored-by: KDecay <KDecayMusic@protonmail.com>
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 S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants