Apply commenting from code review

Adds additional clarification to more obscure functions/inputs.
jatkinson1000 · Jan 25, 2025 · e152652 · e152652
1 parent 8988c86
commit e152652
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/archeryutils/classifications/agb_outdoor_classifications.py b/archeryutils/classifications/agb_outdoor_classifications.py
@@ -154,7 +154,7 @@ def _assign_min_dist(
     Returns
     -------
     min_dists : array of int
-        minimum distance [m] required for this category
+        minimum distance [m] required for this category for each classification (EMB -> A3)
 
     References
     ----------
@@ -189,6 +189,7 @@ def _assign_min_dist(
     else:
         idxs = np.array([0, 0, 0, 0, 0, 1, 2, 3, 4])
 
+    # Extract the relevant distances for each classification from the dists array and return
     return np.take(dists, idxs + max_dist_index, mode="clip")