add docstring to _set_farfield

lumicks · Nov 4, 2024 · 3e36aa1 · 3e36aa1
1 parent e57732d
commit 3e36aa1
Showing 1 changed file with 3 additions and 6 deletions.
diff --git a/src/lumicks/pyoptics/trapping/plane_wave_field_calculation.py b/src/lumicks/pyoptics/trapping/plane_wave_field_calculation.py
@@ -16,9 +16,9 @@
 
 
 def _set_farfield(theta: float, phi: float, polarization: Tuple[float, float], k: float):
-    # Create a FarFieldData object that contains a single pixel == single
-    # plane wave with angles theta and phi and with amplitude and
-    # polarization (E_theta, E_phi) given by `polarization`
+    """Create a FarFieldData object that contains a single pixel (= single
+    plane wave) with angles `theta` and `phi`, and with amplitude and polarization (E_theta, E_phi)
+    given by `polarization`"""
     cos_theta = np.atleast_2d(np.cos(theta))
     sin_theta = np.atleast_2d(np.sin(theta))
     cos_phi = np.atleast_2d(np.cos(phi))
@@ -51,9 +51,6 @@ def _plane_wave_field_factory(
     local_coordinates: LocalBeadCoordinates,
     internal: bool,
 ):
-
-    n_orders = n_orders
-
     local_coordinates = (
         InternalBeadCoordinates(local_coordinates)
         if internal