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

Be more specific with angle parameter names #598

Closed
RobWalt opened this issue Jan 27, 2025 · 1 comment
Closed

Be more specific with angle parameter names #598

RobWalt opened this issue Jan 27, 2025 · 1 comment

Comments

@RobWalt
Copy link

RobWalt commented Jan 27, 2025

Hey, this is just an idea. Feel free to discard it, if it's stupid.

Yesterday I was working on a little PR in bevy (bevyengine/bevy#17545). I made a totally stupid rookie mistake and entered angles in degrees instead of radians in Quat::from_axis_and_angle.

It got me thinking: Would it be an option to rename the angle parameter to radians? I think it would make things more explicit and in some scenarios it could potentially be the one little extra hurdle that prevents a mistake like mine, since:

  • the names are displayed in rendered doc comments in most editors
  • the names are pre-filled when auto completing functions in some editors

Anyways, if you don't like it, feel free to close this issue without any second thoughts. I'll open a PR for this. Feel free to close it as well if you don't like the idea.

@bitshifter
Copy link
Owner

Decided not to make this change

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants