From 5736faf0c1750af4868ad1ec7b4428edc06eab93 Mon Sep 17 00:00:00 2001
From: Robin KAY <komadori@gekkou.co.uk>
Date: Mon, 8 Aug 2022 23:56:50 +0100
Subject: [PATCH] Add comment about outline normals.

---
 src/lib.rs | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/src/lib.rs b/src/lib.rs
index 8f4232e..ca86acd 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -83,6 +83,9 @@ pub enum GenerateOutlineNormalsError {
 pub trait OutlineMeshExt {
     /// Generates outline normals for the mesh by normalising the sum of the regular normals.
     ///
+    /// To the extent that outline normals are not perpendicular to the surface of the mesh,
+    /// this may result in non-uniform outline thickness.
+    ///
     /// This function will silently do nothing if the outline normals would be equal to the
     /// regular normals.
     fn generate_outline_normals(&mut self) -> Result<(), GenerateOutlineNormalsError>;