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

[Merged by Bors] - Fix doc_markdown lints in bevy_input #3475

Closed
wants to merge 1 commit into from
Closed

[Merged by Bors] - Fix doc_markdown lints in bevy_input #3475

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions crates/bevy_input/src/gamepad.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ use bevy_utils::{tracing::info, HashMap, HashSet};
pub struct Gamepad(pub usize);

#[derive(Default)]
/// Container of unique connected [Gamepad]s
/// Container of unique connected [`Gamepad`]s
///
/// [Gamepad]s are registered and deregistered in [gamepad_connection_system]
/// [`Gamepad`]s are registered and deregistered in [`gamepad_connection_system`]
pub struct Gamepads {
gamepads: HashSet<Gamepad>,
}
Expand Down
2 changes: 1 addition & 1 deletion crates/bevy_input/src/keyboard.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ pub struct KeyboardInput {
pub state: ElementState,
}

/// Updates the Input<KeyCode> resource with the latest KeyboardInput events
/// Updates the `Input<KeyCode>` resource with the latest `KeyboardInput` events
pub fn keyboard_input_system(
mut keyboard_input: ResMut<Input<KeyCode>>,
mut keyboard_input_events: EventReader<KeyboardInput>,
Expand Down
2 changes: 1 addition & 1 deletion crates/bevy_input/src/mouse.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ pub struct MouseWheel {
pub y: f32,
}

/// Updates the Input<MouseButton> resource with the latest MouseButtonInput events
/// Updates the `Input<MouseButton>` resource with the latest `MouseButtonInput` events
pub fn mouse_button_input_system(
mut mouse_button_input: ResMut<Input<MouseButton>>,
mut mouse_button_input_events: EventReader<MouseButtonInput>,
Expand Down
2 changes: 1 addition & 1 deletion crates/bevy_input/src/system.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ use crate::{
use bevy_app::AppExit;
use bevy_ecs::prelude::{EventReader, EventWriter};

/// Sends the AppExit event whenever the "esc" key is pressed.
/// Sends the `AppExit` event whenever the "esc" key is pressed.
pub fn exit_on_esc_system(
mut keyboard_input_events: EventReader<KeyboardInput>,
mut app_exit_events: EventWriter<AppExit>,
Expand Down
2 changes: 1 addition & 1 deletion crates/bevy_input/src/touch.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -220,7 +220,7 @@ impl Touches {
}
}

/// Updates the Touches resource with the latest TouchInput events
/// Updates the `Touches` resource with the latest `TouchInput` events
pub fn touch_screen_input_system(
mut touch_state: ResMut<Touches>,
mut touch_input_events: EventReader<TouchInput>,
Expand Down