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.

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

Documentation error #19

Open
clinuxrulz opened this issue Feb 6, 2024 · 1 comment
Open

Documentation error #19

clinuxrulz opened this issue Feb 6, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Milestone

Comments

@clinuxrulz
Copy link
Contributor

Just a documentation error:

Inside VirtualJoystickEvent<S>:

    /// Delta value ranging from 0 to 1 in each vector (x and y)
    pub fn axis(&self) -> Vec2 {
        self.delta
    }

I thought from the documentation for x-axis 0 was all the way to the left, and 1 is all the way to right right.
But for the x-axis -1 is left and +1 is right. Similar for y-axis.

Maybe it should say:
/// Delta value ranging from -1 to 1 in each vector (x and y)

@clinuxrulz clinuxrulz added the bug Something isn't working label Feb 6, 2024
@clinuxrulz
Copy link
Contributor Author

Please change label to enhancement. I clicked the wrong one, sorry.

@SergioRibera SergioRibera added enhancement New feature or request documentation Improvements or additions to documentation and removed bug Something isn't working labels Feb 6, 2024
@SergioRibera SergioRibera added this to the v2.3.0 milestone Mar 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants