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

Additional doc aliases for WindingOrder in bevy_math #13065

Merged
merged 1 commit into from
Apr 22, 2024

Conversation

TheNullicorn
Copy link
Contributor

Objective

Adds a few extra #[doc(alias)] entries to the bevy_math::primitives::WindingOrder enum and its variants to improve searchability.

Solution

  • Add "Orientation" for WindingOrder itself
  • Add "AntiClockwise" for CounterClockwise variant
  • Add "Collinear" for Invalid variant

These alternate terms seem to be quite common, especially in the contexts of rendering and collision-detection.

- Add "Orientation" for `WindingOrder` itself
- Add "AntiClockwise" for `CounterClockwise` variant
- Add "Collinear" for `Invalid` variant

Signed-off-by: Nullicorn <git@nullicorn.me>
Copy link
Contributor

Welcome, new contributor!

Please make sure you've read our contributing guide and we look forward to reviewing your pull request shortly ✨

@matiqo15 matiqo15 added C-Docs An addition or correction to our documentation A-Math Fundamental domain-agnostic mathematical operations labels Apr 22, 2024
Copy link
Contributor

@NthTensor NthTensor left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Alias on Orientation seems a bit broad. But I'm ok with it, it should be unambiguous in context.

@mockersf mockersf added the S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it label Apr 22, 2024
@mockersf mockersf added this pull request to the merge queue Apr 22, 2024
Merged via the queue into bevyengine:main with commit f496d2a Apr 22, 2024
31 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-Math Fundamental domain-agnostic mathematical operations C-Docs An addition or correction to our documentation S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants