Skip to content

Commit fdd577a

Browse files
committed
update objects show_xxx docstrings
1 parent 67aebc9 commit fdd577a

File tree

3 files changed

+15
-11
lines changed

3 files changed

+15
-11
lines changed

src/compas/scene/graphobject.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,9 @@ class GraphObject(SceneObject):
3030
The size of the nodes. Default is ``1.0``.
3131
edgewidth : float
3232
The width of the edges. Default is ``1.0``.
33-
show_nodes : bool
33+
show_nodes : Union[bool, sequence[float]]
3434
Flag for showing or hiding the nodes. Default is ``True``.
35-
show_edges : bool
35+
show_edges : Union[bool, sequence[tuple[hashable, hashable]]]
3636
Flag for showing or hiding the edges. Default is ``True``.
3737
3838
See Also

src/compas/scene/meshobject.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,10 @@ class MeshObject(SceneObject):
3434
The size of the vertices. Default is ``1.0``.
3535
edgewidth : float
3636
The width of the edges. Default is ``1.0``.
37-
show_vertices : Union[bool, sequence[int]]
37+
show_vertices : Union[bool, sequence[float]]
3838
Flag for showing or hiding the vertices, or a list of keys for the vertices to show.
3939
Default is ``False``.
40-
show_edges : Union[bool, sequence[int]]
40+
show_edges : Union[bool, sequence[tuple[int, int]]]
4141
Flag for showing or hiding the edges, or a list of keys for the edges to show.
4242
Default is ``True``.
4343
show_faces : Union[bool, sequence[int]]

src/compas/scene/volmeshobject.py

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -38,14 +38,18 @@ class VolMeshObject(SceneObject):
3838
The size of the vertices. Default is ``1.0``.
3939
edgewidth : float
4040
The width of the edges. Default is ``1.0``.
41-
show_vertices : bool
42-
Flag for showing or hiding the vertices. Default is ``False``.
43-
show_edges : bool
44-
Flag for showing or hiding the edges. Default is ``True``.
45-
show_faces : bool
46-
Flag for showing or hiding the faces. Default is ``True``.
41+
show_vertices : Union[bool, sequence[float]]
42+
Flag for showing or hiding the vertices, or a list of keys for the vertices to show.
43+
Default is ``False``.
44+
show_edges : Union[bool, sequence[tuple[int, int]]]
45+
Flag for showing or hiding the edges, or a list of keys for the edges to show.
46+
Default is ``True``.
47+
show_faces : Union[bool, sequence[int]]
48+
Flag for showing or hiding the faces, or a list of keys for the faces to show.
49+
Default is ``True``.
4750
show_cells : bool
48-
Flag for showing or hiding the cells. Default is ``True``.
51+
Flag for showing or hiding the cells, or a list of keys for the cells to show.
52+
Default is ``True``.
4953
5054
See Also
5155
--------

0 commit comments

Comments
 (0)