Small changes to the wording of some comments

AIP21 · May 20, 2023 · a0ecfea · a0ecfea
1 parent 64a705e
commit a0ecfea
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 4 deletions.
diff --git a/Assets/DataStructure/Data/AbstractCellData.cs b/Assets/DataStructure/Data/AbstractCellData.cs
@@ -12,7 +12,7 @@ public abstract class AbstractCellData
         <summary>
             Whether this cell data is static.
 
-            A static cell data means that it's gameObject does not move around, and so would always in the same cell.
+            A static cell data means that its gameObject does not move around, and so would always be in the same cell.
         </summary>
         **/
         private bool isStatic;

diff --git a/Assets/DataStructure/Data/AbstractGridData.cs b/Assets/DataStructure/Data/AbstractGridData.cs
@@ -5,7 +5,7 @@
 namespace SimDataStructure.Data
 {
     // Data for whole grid (one instance per grid).
-    // This is IMMUTABLE
+    // This should be treated as IMMUTABLE
     [Serializable]
     public abstract class AbstractGridData
     {
@@ -32,7 +32,7 @@ Copies the data from the given object to this AbstractGridData.
         /**
         <summary>
             Dispose this data. (Dispose any buffers, textures, etc from memory)
-            This should ALWAYS be called before this object is destroyed or discarded.
+            This should ALWAYS be called before this object is destroyed or discarded. (Although, this should not be commonly used because you want to keep the same data object at runtime)
         </summary>
         **/
         public abstract void Dispose();

diff --git a/Assets/DataStructure/Scripts/Grid.cs b/Assets/DataStructure/Scripts/Grid.cs
@@ -24,7 +24,7 @@ public class Grid
 
         public int xCellCount, yCellCount;
 
-        // Compute shader data
+        // Grid data
         public GenericDictionary<string, AbstractGridData> gridData = new GenericDictionary<string, AbstractGridData>();
         #endregion