Skip to content

Commit 813512d

Browse files
committed
chore: document create_cylindrical_mesh
[ci skip]
1 parent 6ca2bce commit 813512d

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

pyneuroml/plot/PlotMorphologyVispy.py

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1066,11 +1066,16 @@ def create_cylindrical_mesh(
10661066
"""Create a cylinderical mesh, adapted from vispy's generation method:
10671067
https://github.com/vispy/vispy/blob/main/vispy/geometry/generation.py#L451
10681068
1069-
:param rows: TODO
1070-
:param cols: TODO
1071-
:param radius: TODO
1072-
:param length: TODO
1073-
:param closed: TODO
1069+
:param rows: number of rows to use for mesh
1070+
:type rows: int
1071+
:param cols: number of columns
1072+
:type cols: int
1073+
:param radius: float or pair of floats for the two radii of the cylinder
1074+
:type radius: float or [float, float][]
1075+
:param length: length of cylinder
1076+
:type length: float
1077+
:param closed: whether the cylinder should be closed
1078+
:type closed: bool
10741079
:returns: Vertices and faces computed for a cylindrical surface.
10751080
:rtype: MeshData
10761081

0 commit comments

Comments
 (0)