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

Fix documentation on RegularPolygon #8164

Merged
merged 3 commits into from
Mar 22, 2023

Conversation

p-hueber
Copy link
Contributor

@p-hueber p-hueber commented Mar 22, 2023

A RegularPolygon is described by the circumscribed radius, not the inscribed radius.

Objective

  • Correct documentation for RegularPolygon

Solution

  • Use the correct term

A `RegularPolygon` is described by the circumscribed radius, not the
inscribed radius.
@github-actions
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 ✨

@james7132 james7132 added C-Docs An addition or correction to our documentation A-Rendering Drawing game state to the screen labels Mar 22, 2023
@james7132 james7132 added this to the 0.10.1 milestone Mar 22, 2023
Co-authored-by: Paul Hüber <45110470+p-hueber@users.noreply.github.com>
@alice-i-cecile alice-i-cecile 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 Mar 22, 2023
@alice-i-cecile
Copy link
Member

@p-hueber once this is passing CI I'll merge this in for you :)

@p-hueber
Copy link
Contributor Author

@alice-i-cecile thanks, I pushed a white-space fixup. Do you need me to squash anything?

@mockersf mockersf added this pull request to the merge queue Mar 22, 2023
@mockersf mockersf merged commit 4f16d6e into bevyengine:main Mar 22, 2023
@alice-i-cecile
Copy link
Member

We squash on merge here, and try not to worry too much about commit history within PRs.

mockersf pushed a commit that referenced this pull request Mar 27, 2023
A `RegularPolygon` is described by the circumscribed radius, not the
inscribed radius.

## Objective

- Correct documentation for `RegularPolygon`

## Solution

- Use the correct term

---------

Co-authored-by: Paul Hüber <phueber@kernsp.in>
Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-Rendering Drawing game state to the screen 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.

4 participants