Merge pull request #4 from LyceanEM/bugfix/correction_of_comment

changed comment for maxdirectivitymapdiscrete to reflect 4d array ret…
LyceanEM · Jun 28, 2023 · 5d81154 · 5d81154
2 parents 73cd607 + 2f427a7
commit 5d81154
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/lyceanem/electromagnetics/beamforming.py b/lyceanem/electromagnetics/beamforming.py
@@ -570,8 +570,8 @@ def MaximumDirectivityMapDiscrete(
 
     Returns
     -------
-    directivity_map : 3D numpy array of float
-        The achieved maximum directivity map. At each point the directivity corresponds to the achieved directivity at
+    directivity_map : 4D numpy array of float
+        The achieved maximum directivity map (a 3D numpy array for each phase resolution) . For each phase resolution for each point the directivity corresponds to the achieved directivity at
         that command angle.
 
     """