From b8ca1139d5108a4d7873d4d44060f2daf403d472 Mon Sep 17 00:00:00 2001
From: Aaron Fenyes <aaron.fenyes@fareycircles.ooo>
Date: Sun, 10 Nov 2024 23:22:30 -0800
Subject: [PATCH] Explain what the `Element::index` field holds

Also, remind us to make the field private when that becomes possible.
---
 app-proto/src/assembly.rs | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/app-proto/src/assembly.rs b/app-proto/src/assembly.rs
index 6c4aeb7..da54210 100644
--- a/app-proto/src/assembly.rs
+++ b/app-proto/src/assembly.rs
@@ -19,7 +19,11 @@ pub struct Element {
     pub representation: DVector<f64>,
     pub constraints: BTreeSet<ConstraintKey>,
     
-    // internal properties, not reflected in any view
+    // the configuration matrix column index that was assigned to this element
+    // last time the assembly was realized
+    /* TO DO */
+    // this is public, as a kludge, because `Element` doesn't have a constructor
+    // yet. it should be made private as soon as the constructor is written
     pub index: usize
 }