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.

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

Bevy Input Docs : gamepad.rs #9469

Merged
merged 7 commits into from
Aug 19, 2023
Merged

Bevy Input Docs : gamepad.rs #9469

merged 7 commits into from
Aug 19, 2023

Conversation

tguichaoua
Copy link
Contributor

@tguichaoua tguichaoua commented Aug 17, 2023 •
edited
Loading

Objective

Complete the documentation of bevy_input (#3492).

This PR is part of a triptych of PRs :

Solution

Add missing documentation on items in gamepad.rs

This was referenced Aug 17, 2023
Merged
Merged
@github-actions
Copy link
Contributor

Example alien_cake_addict failed to run, please try running it locally and check the result.

killercup
killercup reviewed Aug 17, 2023
View reviewed changes
crates/bevy_input/src/gamepad.rs Show resolved Hide resolved
crates/bevy_input/src/gamepad.rs Outdated Show resolved Hide resolved
crates/bevy_input/src/gamepad.rs Outdated Show resolved Hide resolved
crates/bevy_input/src/gamepad.rs
pub fn disconnected(&self) -> bool {
!self.connected()
}
}

/// Gamepad event for when the "value" on the axis changes
/// by an amount larger than the threshold defined in [`GamepadSettings`].
Copy link
Contributor

Choose a reason for hiding this comment

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

Would be interesting to know when this is usually emitted

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I don't see how to make the docs more clear 🤔
Any suggestion ?

crates/bevy_input/src/gamepad.rs Outdated Show resolved Hide resolved
crates/bevy_input/src/gamepad.rs Outdated Show resolved Hide resolved
@killercup
Copy link
Contributor

Great work on adding docs :) I really like seeing this!

@github-actions
Copy link
Contributor

Example alien_cake_addict failed to run, please try running it locally and check the result.

3 similar comments
@github-actions
Copy link
Contributor

Example alien_cake_addict failed to run, please try running it locally and check the result.

@github-actions
Copy link
Contributor

Example alien_cake_addict failed to run, please try running it locally and check the result.

@github-actions
Copy link
Contributor

Example alien_cake_addict failed to run, please try running it locally and check the result.

@github-actions
Copy link
Contributor

Example alien_cake_addict failed to run, please try running it locally and check the result.

@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 Aug 17, 2023
@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 Aug 19, 2023
@alice-i-cecile alice-i-cecile added this pull request to the merge queue Aug 19, 2023
github-merge-queue bot pushed a commit that referenced this pull request Aug 19, 2023
@tguichaoua @killercup
Bevy Input Docs : lib.rs (#9468)
b9ab17e 
# Objective

Complete the documentation of `bevy_input` (#3492).

This PR is part of a triptych of PRs :
- #9467
- #9469

## Solution

Add missing documentation on items in `lib.rs`.

---------

Co-authored-by: Pascal Hertleif <[email protected]>
Merged via the queue into bevyengine:main with commit 5db4a04 Aug 19, 2023
22 of 23 checks passed
github-merge-queue bot pushed a commit that referenced this pull request Aug 23, 2023
@tguichaoua
Bevy Input Docs : the modules (#9467)
20c85b5 
# Objective

Complete the documentation of `bevy_input` (#3492).

This PR is part of a triptych of PRs :
- #9468
- #9469

## Solution

Add documentation on modules in `bevy_input`.
@tguichaoua tguichaoua deleted the docs/bevy_input/gamepad branch August 23, 2023 13:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@killercup killercup killercup left review comments

@alice-i-cecile alice-i-cecile alice-i-cecile approved these changes

Assignees
No one assigned
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
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@tguichaoua @killercup @alice-i-cecile