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

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

Closed

ghost wants to merge 3 commits into bevyengine:main from unknown repository

ghost commented Aug 2, 2022 •

edited by ghost

Loading

Objective

Fixes GamepadEventsRaw vs GamepadEvents is confusing and undocumented #5544
Part of the splitting process of docs: Documentation and clean up of bevy_input #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.


          Document gamepad.rs

8d7ffff

ghost added C-Docs A-Input labels

alice-i-cecile self-requested a review

August 2, 2022 03:24


          Rephrase and small fix

ae01ac3

alice-i-cecile reviewed

View reviewed changes

crates/bevy_input/src/gamepad.rs Show resolved Hide resolved

alice-i-cecile reviewed

View reviewed changes

crates/bevy_input/src/gamepad.rs Outdated Show resolved Hide resolved

alice-i-cecile reviewed

View reviewed changes

crates/bevy_input/src/gamepad.rs Outdated Show resolved Hide resolved

alice-i-cecile reviewed

View reviewed changes

crates/bevy_input/src/gamepad.rs Outdated Show resolved Hide resolved

alice-i-cecile reviewed

View reviewed changes

crates/bevy_input/src/gamepad.rs Outdated Show resolved Hide resolved

alice-i-cecile reviewed

View reviewed changes

crates/bevy_input/src/gamepad.rs Outdated Show resolved Hide resolved

alice-i-cecile reviewed

View reviewed changes

crates/bevy_input/src/gamepad.rs Outdated Show resolved Hide resolved

alice-i-cecile reviewed

View reviewed changes

crates/bevy_input/src/gamepad.rs Outdated Show resolved Hide resolved

alice-i-cecile reviewed

View reviewed changes

crates/bevy_input/src/gamepad.rs Outdated Show resolved Hide resolved

alice-i-cecile reviewed

View reviewed changes

crates/bevy_input/src/gamepad.rs Show resolved Hide resolved

alice-i-cecile reviewed

View reviewed changes

crates/bevy_input/src/gamepad.rs Show resolved Hide resolved

alice-i-cecile requested changes

View reviewed changes

Member

alice-i-cecile left a comment

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


          Restructuring, example removal and smaller changes

f43f308

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.

alice-i-cecile approved these changes

View reviewed changes

Member

cart commented Aug 5, 2022

bors r+

bors bot pushed a commit that referenced this pull request


          Document gamepad.rs (#5548)

4b1a990

# 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


          Document gamepad.rs (#5548)

54750de

# 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.

Contributor

bors bot commented Aug 5, 2022

Pull request successfully merged into main.

Build succeeded:

bors bot changed the title ~~Document gamepad.rs~~ [Merged by Bors] - Document gamepad.rs

bors bot closed this

ghost deleted the document_gamepad branch

August 7, 2022 08:27

maccesch pushed a commit to Synphonyte/bevy that referenced this pull request


          Document gamepad.rs (bevyengine#5548)

fa98842

# 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


          Document gamepad.rs (bevyengine#5548)

95a51ce

# 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


          Document gamepad.rs (bevyengine#5548)

45f4e89

# 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