From 0ed7917f4f79f18c0905d401060336b5b115042c Mon Sep 17 00:00:00 2001 From: Carter Anderson Date: Mon, 18 Nov 2024 13:55:40 -0800 Subject: [PATCH] Apply suggestions from code review Co-authored-by: Hennadii Chernyshchyk Co-authored-by: Rob Parrett --- crates/bevy_input/src/gamepad.rs | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/crates/bevy_input/src/gamepad.rs b/crates/bevy_input/src/gamepad.rs index 9d2a4773e7..db0aca53fd 100644 --- a/crates/bevy_input/src/gamepad.rs +++ b/crates/bevy_input/src/gamepad.rs @@ -307,13 +307,12 @@ pub enum ButtonSettingsError { }, } -/// The [`Gamepad`] [`component`](Component) stores a connected gamepad's metadata such as the `name` and its [`GamepadButton`] and [`GamepadAxis`]. +/// Stores a connected gamepad's metadata such as the name and its [`GamepadButton`] and [`GamepadAxis`]. /// -/// The [`entity`](Entity) representing a gamepad and its [`minimal components`](GamepadSettings) are automatically managed. +/// An entity with this component is spawned automatically after [`GamepadConnectionEvent`] +/// and updated by [`gamepad_event_processing_system`]. /// -/// # Usage -/// -/// The only way to obtain a [`Gamepad`] is by [`query`](Query). +/// See also [`GamepadSettings`] for configuration. /// /// # Examples /// @@ -413,7 +412,7 @@ impl Gamepad { self.digital.pressed(button_type) } - /// Returns `true` if any item in [`GamepadButton`] has been pressed. + /// Returns `true` if any item in the [`GamepadButton`] iterator has been pressed. pub fn any_pressed(&self, button_inputs: impl IntoIterator) -> bool { button_inputs .into_iter()