Fixing docstring so arg order matches parameter list
@@ -888,8 +888,9 @@ def blobs(shape: List[int], porosity: float = 0.5, blobiness: int = 1):
def cylinders(shape: List[int], radius: int, ncylinders: int,
phi_max: float = 0, theta_max: float = 90, length: float = None):
r"""
- Generates a binary image of overlapping cylinders. This is a good
- approximation of a fibrous mat.
+ Generates a binary image of overlapping cylinders.
+
+ This is a good approximation of a fibrous mat.
Parameters
----------
@@ -902,16 +903,16 @@ def cylinders(shape: List[int], radius: int, ncylinders: int,
The number of cylinders to add to the domain. Adjust this value to
control the final porosity, which is not easily specified since
cylinders overlap and intersect different fractions of the domain.
- theta_max : scalar
- A value between 0 and 90 that controls the amount of rotation *in the*
- XY plane, with 0 meaning all cylinders point in the X-direction, and
- 90 meaning they are randomly rotated about the Z axis by as much
- as +/- 90 degrees.
phi_max : scalar
A value between 0 and 90 that controls the amount that the cylinders
lie *out of* the XY plane, with 0 meaning all cylinders lie in the XY
plane, and 90 meaning that cylinders are randomly oriented out of the
plane by as much as +/- 90 degrees.
+ theta_max : scalar
+ A value between 0 and 90 that controls the amount of rotation *in the*
+ XY plane, with 0 meaning all cylinders point in the X-direction, and
+ 90 meaning they are randomly rotated about the Z axis by as much
+ as +/- 90 degrees.
length : scalar
The length of the cylinders to add. If ``None`` (default) then the
cylinders will extend beyond the domain in both directions so no ends
