Docstring improvements to mention the code is array foccussed

pyxem · Sep 7, 2020 · 9af5f65 · 9af5f65
1 parent 3506399
commit 9af5f65
Showing 1 changed file with 6 additions and 6 deletions.
diff --git a/diffsims/utils/shape_factor_models.py b/diffsims/utils/shape_factor_models.py
@@ -25,15 +25,15 @@ def binary(excitation_error, max_excitation_error):
 
     Parameters
     ----------
-    excitation_error : float
+    excitation_error : array-like or float
         The distance (reciprocal) from a reflection to the Ewald sphere
 
     max_excitation_error : float
         The distance at which a reflection becomes extinct
 
     Returns
     -------
-    intensity : float
+    intensities : array-like or float
     """
     return 1
 
@@ -44,15 +44,15 @@ def linear(excitation_error, max_excitation_error):
 
     Parameters
     ----------
-    excitation_error : float
+    excitation_error : array-like or float
         The distance (reciprocal) from a reflection to the Ewald sphere
 
     max_excitation_error : float
         The distance at which a reflection becomes extinct
 
     Returns
     -------
-    intensity : float
+    intensities : array-like or float
     """
 
     return 1 - excitation_error / max_excitation_error
@@ -64,7 +64,7 @@ def sinc(excitation_error, max_excitation_error, minima_number=5):
 
     Parameters
     ----------
-    excitation_error : float
+    excitation_error : array-like or float
         The distance (reciprocal) from a reflection to the Ewald sphere
 
     max_excitation_error : float
@@ -75,7 +75,7 @@ def sinc(excitation_error, max_excitation_error, minima_number=5):
 
     Returns
     -------
-    intensity : float
+    intensity : array-like or float
     """
 
     num = np.sin(np.pi * minima_number * excitation_error / max_excitation_error)