Skip to content

Commit

Permalink
Update document
Browse files Browse the repository at this point in the history
  • Loading branch information
Shute052 committed Feb 23, 2024
1 parent 6d1d202 commit 8db90b9
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions src/user_inputs/axislike_settings.rs
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ pub struct SingleAxisDeadzone {
impl SingleAxisDeadzone {
/// The default deadzone with a small offset to filter out near-zero input values.
///
/// This deadzone excludes input values within the range [-0.1, 0.1].
/// This deadzone excludes input values within the range `[-0.1, 0.1]`.
pub const DEFAULT: Self = Self {
negative_low: -0.1,
positive_low: 0.1,
Expand All @@ -178,14 +178,14 @@ impl SingleAxisDeadzone {

/// The deadzone that only filters out the zeroes.
///
/// This deadzone does not filter out near-zero negative or positive values.
/// This deadzone doesn't filter out near-zero negative or positive values.
pub const ZERO: Self = Self {
negative_low: 0.0,
positive_low: 0.0,
negative_low_width: 0.0,
};

/// Creates a new [`SingleAxisDeadzone`] with the given settings.
/// Creates a new [`SingleAxisDeadzone`] to filter out input values within the range `[negative_low, positive_low]`.
///
/// # Arguments
///
Expand Down Expand Up @@ -229,7 +229,7 @@ impl SingleAxisDeadzone {
///
/// This function calculates the deadzone width based on the input value and the deadzone settings.
/// If the input value falls within the deadzone range, it returns `0.0`.
/// Otherwise, it normalizes the input value into the range [-1.0, 1.0] by subtracting the deadzone width.
/// Otherwise, it normalizes the input value into the range `[-1.0, 1.0]` by subtracting the deadzone width.
///
/// # Panics
///
Expand Down

0 comments on commit 8db90b9

Please sign in to comment.