Get -> Return, line length <=79

adding mgeier suggestions

Author: fs446

sfs/array.py

@@ -15,7 +15,7 @@
 
 
 class ArrayData(namedtuple('ArrayData', 'x n a')):
-    """Get named tuple returned by array functions.
+    """Named tuple returned by array functions.
 
     See `collections.namedtuple`.
 
@@ -43,7 +43,7 @@ def take(self, indices):
 
 
 def linear(N, spacing, center=[0, 0, 0], orientation=[1, 0, 0]):
-    """Get linear, equidistantly sampled secondary source distribution.
+    """Return linear, equidistantly sampled secondary source distribution.
 
     Parameters
     ----------
@@ -78,7 +78,7 @@ def linear(N, spacing, center=[0, 0, 0], orientation=[1, 0, 0]):
 
 
 def linear_diff(distances, center=[0, 0, 0], orientation=[1, 0, 0]):
-    """Get linear secondary source distribution from a list of distances.
+    """Return linear secondary source distribution from a list of distances.
 
     Parameters
     ----------
@@ -112,7 +112,7 @@ def linear_diff(distances, center=[0, 0, 0], orientation=[1, 0, 0]):
 
 def linear_random(N, min_spacing, max_spacing, center=[0, 0, 0],
                   orientation=[1, 0, 0], seed=None):
-    """Get randomly sampled linear array.
+    """Return randomly sampled linear array.
 
     Parameters
     ----------
@@ -136,7 +136,10 @@ def linear_random(N, min_spacing, max_spacing, center=[0, 0, 0],
     .. plot::
         :context: close-figs
 
-        x0, n0, a0 = sfs.array.linear_random(12, 0.15, 0.4, orientation=[0, -1, 0])
+        x0, n0, a0 = sfs.array.linear_random(
+            N=12,
+            min_spacing=0.15, max_spacing=0.4,
+            orientation=[0, -1, 0])
         sfs.plot.loudspeaker_2d(x0, n0, a0)
         plt.axis('equal')
         plt.xlabel('x / m')
@@ -149,7 +152,7 @@ def linear_random(N, min_spacing, max_spacing, center=[0, 0, 0],
 
 
 def circular(N, R, center=[0, 0, 0]):
-    """Get circular secondary source distribution parallel to the xy-plane.
+    """Return circular secondary source distribution parallel to the xy-plane.
 
     Parameters
     ----------
@@ -191,7 +194,7 @@ def circular(N, R, center=[0, 0, 0]):
 
 
 def rectangular(N, spacing, center=[0, 0, 0], orientation=[1, 0, 0]):
-    """Get rectangular secondary source distribution.
+    """Return rectangular secondary source distribution.
 
     Parameters
     ----------
@@ -239,7 +242,8 @@ def rectangular(N, spacing, center=[0, 0, 0], orientation=[1, 0, 0]):
 
 
 def rounded_edge(Nxy, Nr, dx, center=[0, 0, 0], orientation=[1, 0, 0]):
-    """Get secondary source distribution along the xy-axis with rounded edge at the origin.
+    """Return secondary source distribution along the xy-axis with rounded
+    edge at the origin.
 
     Parameters
     ----------
@@ -313,7 +317,8 @@ def rounded_edge(Nxy, Nr, dx, center=[0, 0, 0], orientation=[1, 0, 0]):
 
 
 def edge(Nxy, dx, center=[0, 0, 0], orientation=[1, 0, 0]):
-    """Get secondary source distribution along the xy-axis with sharp edge at the origin.
+    """Return secondary source distribution along the xy-axis with sharp
+    edge at the origin.
 
     Parameters
     ----------
@@ -365,7 +370,7 @@ def edge(Nxy, dx, center=[0, 0, 0], orientation=[1, 0, 0]):
 
 
 def planar(N, spacing, center=[0, 0, 0], orientation=[1, 0, 0]):
-    """Get planar secondary source distribtion.
+    """Return planar secondary source distribtion.
 
     Parameters
     ----------
@@ -389,7 +394,9 @@ def planar(N, spacing, center=[0, 0, 0], orientation=[1, 0, 0]):
     .. plot::
         :context: close-figs
 
-        x0, n0, a0 = sfs.array.planar((4,3), 0.5, center=[0, 0, 0], orientation=[0, 0, 1])
+        x0, n0, a0 = sfs.array.planar(
+            N=(4,3), spacing=0.5,
+            center=[0, 0, 0], orientation=[0, 0, 1])
         sfs.plot.loudspeaker_2d(x0, n0, a0)
         plt.axis('equal')
         plt.xlabel('x / m')
@@ -409,7 +416,7 @@ def planar(N, spacing, center=[0, 0, 0], orientation=[1, 0, 0]):
 
 
 def cube(N, spacing, center=[0, 0, 0], orientation=[1, 0, 0]):
-    """Get cube-shaped secondary source distribtion.
+    """Return cube-shaped secondary source distribtion.
 
     Parameters
     ----------
@@ -433,7 +440,9 @@ def cube(N, spacing, center=[0, 0, 0], orientation=[1, 0, 0]):
     .. plot::
         :context: close-figs
 
-        x0, n0, a0 = sfs.array.cube(2, 0.5, center=[0, 0, 0], orientation=[1, 0, 0])
+        x0, n0, a0 = sfs.array.cube(
+            N=2, spacing=0.5,
+            center=[0, 0, 0], orientation=[1, 0, 0])
         sfs.plot.loudspeaker_2d(x0, n0, a0)
         plt.axis('equal')
         plt.xlabel('x / m')
@@ -489,7 +498,10 @@ def sphere_load(file, radius, center=[0, 0, 0]):
     .. plot::
         :context: close-figs
 
-        x0, n0, a0 = sfs.array.sphere_load('../data/arrays/example_array_6LS_3D.txt', radius=2, center=[0, 0, 0])
+        x0, n0, a0 = sfs.array.sphere_load(
+            '../data/arrays/example_array_6LS_3D.txt',
+            radius=2,
+            center=[0, 0, 0])
         sfs.plot.loudspeaker_2d(x0, n0, a0, size=0.25)
         plt.axis('equal')
         plt.xlabel('x / m')
@@ -541,7 +553,8 @@ def load(file, center=[0, 0, 0], orientation=[1, 0, 0]):
     .. plot::
         :context: close-figs
 
-        x0, n0, a0 = sfs.array.load('../data/arrays/wfs_university_rostock_2018.csv')
+        x0, n0, a0 = sfs.array.load(
+            '../data/arrays/wfs_university_rostock_2018.csv')
         sfs.plot.loudspeaker_2d(x0, n0, a0)
         plt.axis('equal')
         plt.xlabel('x / m')
@@ -626,7 +639,8 @@ def concatenate(*arrays):
     Returns
     -------
     `ArrayData`
-        Positions, orientations and weights of the concatenated secondary sources.
+        Positions, orientations and weights
+        of the concatenated secondary sources.
 
     Examples
     --------