Fixed documentation

zwicker-group · Apr 9, 2024 · 008c3ba · 008c3ba
1 parent 886524a
commit 008c3ba
Showing 1 changed file with 4 additions and 3 deletions.
diff --git a/droplets/image_analysis.py b/droplets/image_analysis.py
@@ -789,12 +789,13 @@ def get_length_scale(
 
     Args:
         scalar_field (:class:`~pde.fields.ScalarField`):
-            The scala field being analyzed
+            The scalar field to analyze
         method (str):
             A string determining which method is used to calculate the length scale.
             Valid options are `structure_factor_maximum` (numerically determine the
-            maximum in the structure factor) and `structure_factor_mean` (calculate the
-            mean of the structure factor).
+            maximum in the structure factor), `structure_factor_mean` (calculate the
+            mean of the structure factor), and `droplet_detection` (determine the number
+            of droplets and estimate average separation).
 
     Additional supported keyword arguments depend on the chosen method. For instance,
     the methods involving the structure factor allow for a boolean flag `full_output`,