prepare for publish

emilyselwood · Jan 24, 2023 · 697fe9d · 697fe9d
1 parent ae20d19
commit 697fe9d
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,5 +1,8 @@
 [package]
 name = "polygonical"
+description = "2d polygon geometry and operations"
+keywords = ["2d", "geometry", "polygon"]
+license = "MIT"
 version = "0.1.0"
 edition = "2021"
 authors = [

diff --git a/src/polygon.rs b/src/polygon.rs
@@ -79,7 +79,12 @@ impl Polygon {
     }
 
     /// Return the area of this polygon
+    /// Note: This will panic if the polygon is self intersecting.
     pub fn area(&self) -> f64 {
+        if self.is_self_intersecting() {
+            panic!("Can not calculate the area of a self intersecting polygon")
+        }
+
         let mut triangle_sum = 0.0;
         let sides = self.sides();
         for s in sides.iter().take(sides.len() - 1) {