Skip to content

[Merged by Bors] - Document gamepad.rs#5548

Closed
ghost wants to merge 3 commits intomainfrom
unknown repository
Closed

[Merged by Bors] - Document gamepad.rs#5548
ghost wants to merge 3 commits intomainfrom
unknown repository

Conversation

@ghost
Copy link

@ghost ghost commented Aug 2, 2022

Objective

Solution

  • Document everything in the gamepad.rs file.
  • Add a doc example for mocking gamepad input.

Changelog

  • Added and updated the documentation inside of the gamepad.rs file.

@ghost ghost added C-Docs An addition or correction to our documentation A-Input Player input via keyboard, mouse, gamepad, and more labels Aug 2, 2022
@alice-i-cecile alice-i-cecile self-requested a review August 2, 2022 03:24
Copy link
Member

@alice-i-cecile alice-i-cecile left a comment

Choose a reason for hiding this comment

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

Some modest feedback. This is a solid improvement over the current absence of docs already.

@ghost
Copy link
Author

ghost commented Aug 3, 2022

@alice-i-cecile Great points. Thank you!

Regarding your request to add another example to the GamepadEventRaw:
I moved the example from the GamepadEvent to the GamepadEventRaw and linked to it in the docs of the GamepadEvent. Let me know if that's what you were after or if you wanted an additional example.

@cart
Copy link
Member

cart commented Aug 5, 2022

bors r+

bors bot pushed a commit that referenced this pull request Aug 5, 2022
# Objective

- Fixes #5544
- Part of the splitting process of #3692.

## Solution

- Document everything in the `gamepad.rs` file.
- Add a doc example for mocking gamepad input.

---

## Changelog

- Added and updated the documentation inside of the `gamepad.rs` file.
bors bot pushed a commit that referenced this pull request Aug 5, 2022
# Objective

- Fixes #5544
- Part of the splitting process of #3692.

## Solution

- Document everything in the `gamepad.rs` file.
- Add a doc example for mocking gamepad input.

---

## Changelog

- Added and updated the documentation inside of the `gamepad.rs` file.
@bors
Copy link
Contributor

bors bot commented Aug 5, 2022

@bors bors bot changed the title Document gamepad.rs [Merged by Bors] - Document gamepad.rs Aug 5, 2022
@bors bors bot closed this Aug 5, 2022
@ghost ghost deleted the document_gamepad branch August 7, 2022 08:27
maccesch pushed a commit to Synphonyte/bevy that referenced this pull request Sep 28, 2022
# Objective

- Fixes bevyengine#5544
- Part of the splitting process of bevyengine#3692.

## Solution

- Document everything in the `gamepad.rs` file.
- Add a doc example for mocking gamepad input.

---

## Changelog

- Added and updated the documentation inside of the `gamepad.rs` file.
james7132 pushed a commit to james7132/bevy that referenced this pull request Oct 28, 2022
# Objective

- Fixes bevyengine#5544
- Part of the splitting process of bevyengine#3692.

## Solution

- Document everything in the `gamepad.rs` file.
- Add a doc example for mocking gamepad input.

---

## Changelog

- Added and updated the documentation inside of the `gamepad.rs` file.
ItsDoot pushed a commit to ItsDoot/bevy that referenced this pull request Feb 1, 2023
# Objective

- Fixes bevyengine#5544
- Part of the splitting process of bevyengine#3692.

## Solution

- Document everything in the `gamepad.rs` file.
- Add a doc example for mocking gamepad input.

---

## Changelog

- Added and updated the documentation inside of the `gamepad.rs` file.
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.

GamepadEventsRaw vs GamepadEvents is confusing and undocumented

2 participants