Skip to content

Commit e269b92

Browse files
gonzalocasasgonzalocasas
committed
doc updates
1 parent 795f2c2 commit e269b92

File tree

7 files changed

+30
-30
lines changed

7 files changed

+30
-30
lines changed

‎src/compas_ghpython/artists/meshartist.py‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -51,10 +51,10 @@ def draw(self, vertices=None, edges=None, faces=None, vertexcolor=None, edgecolo
5151
A selection of faces to draw.
5252
The default is ``None``, in which case all faces are drawn.
5353
vertexcolor : tuple or dict of tuple, optional
54-
The color specififcation for the vertices.
54+
The color specification for the vertices.
5555
The default color is the value of ``~MeshArtist.default_vertexcolor``.
5656
edgecolor : tuple or dict of tuple, optional
57-
The color specififcation for the edges.
57+
The color specification for the edges.
5858
The default color is the value of ``~MeshArtist.default_edgecolor``.
5959
facecolor : tuple or dict of tuple, optional
6060
The color specification for the faces.
@@ -68,7 +68,7 @@ def draw(self, vertices=None, edges=None, faces=None, vertexcolor=None, edgecolo
6868
6969
Returns
7070
-------
71-
:class:`Rhino.Geometry.Mesh`
71+
list of :class:`Rhino.Geometry.Mesh`, :class:`Rhino.Geometry.Point3d` and :class:`Rhino.Geometry.Line` depending on the selection.
7272
"""
7373
geometry = []
7474
if self.show_mesh:
@@ -114,7 +114,7 @@ def draw_vertices(self, vertices=None, color=None):
114114
A selection of vertices to draw.
115115
Default is ``None``, in which case all vertices are drawn.
116116
color : tuple or dict of tuple, optional
117-
The color specififcation for the vertices.
117+
The color specification for the vertices.
118118
The default is the value of ``~MeshArtist.default_vertexcolor``.
119119
120120
Returns
@@ -143,7 +143,7 @@ def draw_faces(self, faces=None, color=None, join_faces=False):
143143
A selection of faces to draw.
144144
The default is ``None``, in which case all faces are drawn.
145145
color : tuple or dict of tuple, optional
146-
The color specififcation for the faces.
146+
The color specification for the faces.
147147
The default color is the value of ``~MeshArtist.default_facecolor``.
148148
join_faces : bool, optional
149149
Join the faces into 1 mesh.
@@ -181,7 +181,7 @@ def draw_edges(self, edges=None, color=None):
181181
A selection of edges to draw.
182182
The default is ``None``, in which case all edges are drawn.
183183
color : tuple or dict of tuple, optional
184-
The color specififcation for the edges.
184+
The color specification for the edges.
185185
The default color is the value of ``~MeshArtist.default_edgecolor``.
186186
187187
Returns

‎src/compas_ghpython/artists/networkartist.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ def draw_nodes(self, nodes=None, color=None):
4444
The selection of nodes that should be drawn.
4545
Default is ``None``, in which case all nodes are drawn.
4646
color: 3-tuple or dict of 3-tuple, optional
47-
The color specififcation for the nodes.
47+
The color specification for the nodes.
4848
The default color is ``(255, 255, 255)``.
4949
5050
Returns
@@ -72,7 +72,7 @@ def draw_edges(self, edges=None, color=None):
7272
A list of edges to draw.
7373
The default is ``None``, in which case all edges are drawn.
7474
color : tuple or dict of tuple, optional
75-
The color specififcation for the edges.
75+
The color specification for the edges.
7676
The default color is the value of ``~NetworkArtist.default_edgecolor``.
7777
7878
Returns

‎src/compas_ghpython/artists/volmeshartist.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ def draw_vertices(self, vertices=None, color=None):
4040
A list of vertices to draw.
4141
Default is ``None``, in which case all vertices are drawn.
4242
color : str, tuple, dict
43-
The color specififcation for the vertices.
43+
The color specification for the vertices.
4444
The default color of the vertices is ``~VolMeshArtist.default_vertexcolor``.
4545
4646
Returns
@@ -68,7 +68,7 @@ def draw_edges(self, edges=None, color=None):
6868
A list of edges to draw.
6969
The default is ``None``, in which case all edges are drawn.
7070
color : str, tuple, dict
71-
The color specififcation for the edges.
71+
The color specification for the edges.
7272
The default color is ``~VolMeshArtist.default_edgecolor``.
7373
7474
Returns
@@ -97,7 +97,7 @@ def draw_faces(self, faces=None, color=None, join_faces=False):
9797
A list of faces to draw.
9898
The default is ``None``, in which case all faces are drawn.
9999
color : str, tuple, dict
100-
The color specififcation for the faces.
100+
The color specification for the faces.
101101
The default color is ``~VolMeshArtist.default_facecolor``.
102102
103103
Returns

‎src/compas_plotters/plotter.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ def bgcolor(self, value: Union[str, Tuple[float, float, float]]):
161161
Parameters
162162
----------
163163
value : str, tuple
164-
The color specififcation for the figure background.
164+
The color specification for the figure background.
165165
Colors should be specified in the form of a string (hex colors) or
166166
as a tuple of normalized RGB components.
167167

‎src/compas_rhino/artists/meshartist.py‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -120,13 +120,13 @@ def draw(self, vertices=None, edges=None, faces=None, vertexcolor=None, edgecolo
120120
A selection of faces to draw.
121121
The default is ``None``, in which case all faces are drawn.
122122
vertexcolor : tuple or dict of tuple, optional
123-
The color specififcation for the vertices.
123+
The color specification for the vertices.
124124
The default color is the value of ``~MeshArtist.default_vertexcolor``.
125125
edgecolor : tuple or dict of tuple, optional
126-
The color specififcation for the edges.
126+
The color specification for the edges.
127127
The default color is the value of ``~MeshArtist.default_edgecolor``.
128128
facecolor : tuple or dict of tuple, optional
129-
The color specififcation for the faces.
129+
The color specification for the faces.
130130
The default color is the value of ``~MeshArtist.default_facecolor``.
131131
join_faces : bool, optional
132132
Join the faces into 1 mesh.
@@ -200,7 +200,7 @@ def draw_vertices(self, vertices=None, color=None):
200200
A selection of vertices to draw.
201201
Default is ``None``, in which case all vertices are drawn.
202202
color : tuple or dict of tuple, optional
203-
The color specififcation for the vertices.
203+
The color specification for the vertices.
204204
The default is the value of ``~MeshArtist.default_vertexcolor``.
205205
206206
Returns
@@ -231,7 +231,7 @@ def draw_edges(self, edges=None, color=None):
231231
A selection of edges to draw.
232232
The default is ``None``, in which case all edges are drawn.
233233
color : tuple or dict of tuple, optional
234-
The color specififcation for the edges.
234+
The color specification for the edges.
235235
The default color is the value of ``~MeshArtist.default_edgecolor``.
236236
237237
Returns
@@ -263,7 +263,7 @@ def draw_faces(self, faces=None, color=None, join_faces=False):
263263
A selection of faces to draw.
264264
The default is ``None``, in which case all faces are drawn.
265265
color : tuple or dict of tuple, optional
266-
The color specififcation for the faces.
266+
The color specification for the faces.
267267
The default color is the value of ``~MeshArtist.default_facecolor``.
268268
join_faces : bool, optional
269269
Join the faces into 1 mesh.

‎src/compas_rhino/artists/networkartist.py‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -97,10 +97,10 @@ def draw(self, nodes=None, edges=None, nodecolor=None, edgecolor=None):
9797
A list of edges to draw.
9898
The default is ``None``, in which case all edges are drawn.
9999
nodecolor : tuple or dict of tuple, optional
100-
The color specififcation for the nodes.
100+
The color specification for the nodes.
101101
The default color is the value of ``~NetworkArtist.default_nodecolor``.
102102
edgecolor : tuple or dict of tuple, optional
103-
The color specififcation for the edges.
103+
The color specification for the edges.
104104
The default color is the value of ``~NetworkArtist.default_edgecolor``.
105105
106106
Returns
@@ -122,7 +122,7 @@ def draw_nodes(self, nodes=None, color=None):
122122
A list of nodes to draw.
123123
Default is ``None``, in which case all nodes are drawn.
124124
color : tuple or dict of tuple, optional
125-
The color specififcation for the nodes.
125+
The color specification for the nodes.
126126
The default color is the value of ``~NetworkArtist.default_nodecolor``.
127127
128128
Returns
@@ -151,7 +151,7 @@ def draw_edges(self, edges=None, color=None):
151151
A list of edges to draw.
152152
The default is ``None``, in which case all edges are drawn.
153153
color : tuple or dict of tuple, optional
154-
The color specififcation for the edges.
154+
The color specification for the edges.
155155
The default color is the value of ``~NetworkArtist.default_edgecolor``.
156156
157157
Returns

‎src/compas_rhino/artists/volmeshartist.py‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -55,16 +55,16 @@ def draw(self, vertices=None, edges=None, faces=None, cells=None, vertexcolor=No
5555
A selection of cells to draw.
5656
The default is ``None``, in which case all cells are drawn.
5757
vertexcolor : tuple or dict of tuple, optional
58-
The color specififcation for the vertices.
58+
The color specification for the vertices.
5959
The default color is the value of ``~VolMeshArtist.default_vertexcolor``.
6060
edgecolor : tuple or dict of tuple, optional
61-
The color specififcation for the edges.
61+
The color specification for the edges.
6262
The default color is the value of ``~VolMeshArtist.default_edgecolor``.
6363
facecolor : tuple or dict of tuple, optional
64-
The color specififcation for the faces.
64+
The color specification for the faces.
6565
The default color is the value of ``~VolMeshArtist.default_facecolor``.
6666
cellcolor : tuple or dict of tuple, optional
67-
The color specififcation for the cells.
67+
The color specification for the cells.
6868
The default color is the value of ``~VolMeshArtist.default_cellcolor``.
6969
7070
Returns
@@ -88,7 +88,7 @@ def draw_vertices(self, vertices=None, color=None):
8888
A list of vertices to draw.
8989
Default is ``None``, in which case all vertices are drawn.
9090
color : str, tuple, dict
91-
The color specififcation for the vertices.
91+
The color specification for the vertices.
9292
The default color of the vertices is ``~VolMeshArtist.default_vertexcolor``.
9393
9494
Returns
@@ -118,7 +118,7 @@ def draw_edges(self, edges=None, color=None):
118118
A list of edges to draw.
119119
The default is ``None``, in which case all edges are drawn.
120120
color : str, tuple, dict
121-
The color specififcation for the edges.
121+
The color specification for the edges.
122122
The default color is ``~VolMeshArtist.default_edgecolor``.
123123
124124
Returns
@@ -149,7 +149,7 @@ def draw_faces(self, faces=None, color=None):
149149
A list of faces to draw.
150150
The default is ``None``, in which case all faces are drawn.
151151
color : str, tuple, dict
152-
The color specififcation for the faces.
152+
The color specification for the faces.
153153
The default color is ``~VolMeshArtist.default_facecolor``.
154154
155155
Returns
@@ -179,7 +179,7 @@ def draw_cells(self, cells=None, color=None):
179179
A list of cells to draw.
180180
The default is ``None``, in which case all cells are drawn.
181181
color : str, tuple, dict
182-
The color specififcation for the cells.
182+
The color specification for the cells.
183183
The default color is ``~VolMeshArtist.default_cellcolor``.
184184
185185
Returns

0 commit comments

Comments
 (0)