From d7e9c3cc46d616c2fcd1a6e9f73adbb79c6570b4 Mon Sep 17 00:00:00 2001
From: Arne Dußin
Date: Mon, 21 Dec 2020 01:22:15 +0100
Subject: Add previously missing docs where appropriate

---
 src/math/polygon/mod.rs | 2 ++
 1 file changed, 2 insertions(+)

(limited to 'src/math/polygon/mod.rs')

diff --git a/src/math/polygon/mod.rs b/src/math/polygon/mod.rs
index 98b1570..1577f63 100644
--- a/src/math/polygon/mod.rs
+++ b/src/math/polygon/mod.rs
@@ -15,6 +15,7 @@ use std::ops::Neg;
 use thiserror::Error;
 
 /// Describes errors that can happen when handling polygons, especially on creation.
+#[allow(missing_docs)]
 #[derive(Debug, Error)]
 pub enum PolygonError<T: Scalar + Copy> {
     /// Since the polygon is not allowed to be complex, self intersection is an error.
@@ -28,6 +29,7 @@ pub enum PolygonError<T: Scalar + Copy> {
     EdgeNotFound(LineSegment<T>),
 }
 
+/// Describes a non-complex (non-self-intersecting) polygon, currently without holes.
 #[derive(Clone, Debug, Deserialize, Serialize)]
 // TODO: Support polygons with holes
 pub struct Polygon<T: Scalar + Copy> {
-- 
cgit v1.2.3-70-g09d2