Merge pull request #157 from GazzolaLab/154_endpoint_forces_docstring…

…_fix docs: correct endpoint forces docstring
GazzolaLab · Jul 23, 2022 · 011a0fe · 011a0fe
2 parents f3d3d73 + 24411f3
commit 011a0fe
Showing 1 changed file with 6 additions and 6 deletions.
diff --git a/elastica/external_forces.py b/elastica/external_forces.py
@@ -132,9 +132,9 @@ class EndpointForces(NoForces):
         Attributes
         ----------
         start_force: numpy.ndarray
-            2D (dim, 1) array containing data with 'float' type. Force applied to first node of the rod-like object.
+            1D (dim) array containing data with 'float' type. Force applied to first node of the rod-like object.
         end_force: numpy.ndarray
-            2D (dim, 1) array containing data with 'float' type. Force applied to last node of the rod-like object.
+            1D (dim) array containing data with 'float' type. Force applied to last node of the rod-like object.
         ramp_up_time: float
             Applied forces are ramped up until ramp up time.
 
@@ -146,10 +146,10 @@ def __init__(self, start_force, end_force, ramp_up_time):
         Parameters
         ----------
         start_force: numpy.ndarray
-            2D (dim, 1) array containing data with 'float' type.
+            1D (dim) array containing data with 'float' type.
             Force applied to first node of the rod-like object.
         end_force: numpy.ndarray
-            2D (dim, 1) array containing data with 'float' type.
+            1D (dim) array containing data with 'float' type.
             Force applied to last node of the rod-like object.
         ramp_up_time: float
             Applied forces are ramped up until ramp up time.
@@ -183,9 +183,9 @@ def compute_end_point_forces(
         external_forces: numpy.ndarray
             2D (dim, blocksize) array containing data with 'float' type. External force vector.
         start_force: numpy.ndarray
-            2D (dim, 1) array containing data with 'float' type.
+            1D (dim) array containing data with 'float' type.
         end_force: numpy.ndarray
-            2D (dim, 1) array containing data with 'float' type.
+            1D (dim) array containing data with 'float' type.
             Force applied to last node of the rod-like object.
         time: float
         ramp_up_time: float