Merge #31

31: Fix incircle docs r=urschrei a=urschrei Fixes #30 Co-authored-by: Stephan Hügel <[email protected]>
georust · May 25, 2023 · 6fa7015 · 6fa7015
2 parents 3f4e3ad + 830b78d
commit 6fa7015
Showing 1 changed file with 4 additions and 3 deletions.
diff --git a/src/lib.rs b/src/lib.rs
@@ -557,9 +557,10 @@ fn orient3dadapt(
     finnow[finlength - 1]
 }
 
-/// Returns a positive value if the coordinate `pd` lies **outside** the circle passing through `pa`, `pb`, and `pc`.  
-/// Returns a negative value if it lies **inside** the circle.  
-/// Returns `0` if the four points are **cocircular**.
+/// Returns a positive value if the coordinate `pd` lies **inside** the circle passing through `pa`, `pb`, and `pc`.  
+/// Returns a negative value if it lies **outside** the circle.  
+/// Returns `0` if the four points are **cocircular**.  
+/// **Note**: The points `pa`, `pb`, and `pc` must be in **counterclockwise order**, or the sign of the result will be reversed.
 pub fn incircle<T: Into<f64>>(pa: Coord<T>, pb: Coord<T>, pc: Coord<T>, pd: Coord<T>) -> f64 {
     let pa = Coord {
         x: pa.x.into(),