From 4f16d6e0dc14c12ab29b72880d5d3d22003eed72 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Paul=20H=C3=BCber?= <45110470+p-hueber@users.noreply.github.com> Date: Thu, 23 Mar 2023 00:17:13 +0100 Subject: [PATCH] Fix documentation on RegularPolygon (#8164) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 Co-authored-by: Alice Cecile --- crates/bevy_render/src/mesh/shape/regular_polygon.rs | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/crates/bevy_render/src/mesh/shape/regular_polygon.rs b/crates/bevy_render/src/mesh/shape/regular_polygon.rs index ed47ba3795bd3..b37d8ad633d3c 100644 --- a/crates/bevy_render/src/mesh/shape/regular_polygon.rs +++ b/crates/bevy_render/src/mesh/shape/regular_polygon.rs @@ -4,7 +4,9 @@ use wgpu::PrimitiveTopology; /// A regular polygon in the `XY` plane #[derive(Debug, Copy, Clone)] pub struct RegularPolygon { - /// Inscribed radius in the `XY` plane. + /// Circumscribed radius in the `XY` plane. + /// + /// In other words, the vertices of this polygon will all touch a circle of this radius. pub radius: f32, /// Number of sides. pub sides: usize,