Skip to content

Commit 937da8e

Browse files
committed
small docstring corrections
1 parent 2042d25 commit 937da8e

File tree

5 files changed

+16
-16
lines changed

5 files changed

+16
-16
lines changed

src/compas_rhino/geometry/brep/brep.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -27,19 +27,19 @@ class RhinoBrep(Brep):
2727
Attributes
2828
----------
2929
native_brep : :class:`Rhino.Geometry.Brep`
30-
The underlying Rhino Brep instance,
30+
The underlying Rhino Brep instance.
3131
vertices : list[:class:`~compas_rhino.geometry.RhinoBrepVertex`], read-only
32-
The list of vertices which comprise this Brep,
32+
The list of vertices which comprise this Brep.
3333
points : list[:class:`~compas.geometry.Point`], read-only
34-
The list of vertex geometries as points in 3D space,
34+
The list of vertex geometries as points in 3D space.
3535
edges : list[:class:`~compas_rhino.geometry.RhinoBrepEdge`], read-only
36-
The list of edges which comprise this brep,
36+
The list of edges which comprise this brep.
3737
loops : list[:class:`~compas_rhino.geometry.RhinoBrepLoop`], read-only
38-
The list of loops which comprise this brep,
38+
The list of loops which comprise this brep.
3939
faces : list[:class:`~compas_rhino.geometry.RhinoBrepFace`], read-only
40-
The list of faces which comprise this brep,
40+
The list of faces which comprise this brep.
4141
frame : :class:`~compas.geometry.Frame`, read-only
42-
The brep's origin (Frame.worldXY()),
42+
The brep's origin (Frame.worldXY()).
4343
area : float, read-only
4444
The calculated area of this brep.
4545
volume : float, read-only

src/compas_rhino/geometry/brep/edge.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,11 @@ class RhinoBrepEdge(BrepEdge):
1818
----------
1919
curve : :class:`Rhino.Geometry.Curve3D`
2020
The underlying geometry of this edge.
21-
start_vertex : :class:`~compas_rhino.geometry.RhinoBrepVertex`
21+
start_vertex : :class:`~compas_rhino.geometry.RhinoBrepVertex`, read-only
2222
The start vertex of this edge.
23-
end_vertex : :class:`~compas_rhino.geometry.RhinoBrepVertex`
23+
end_vertex : :class:`~compas_rhino.geometry.RhinoBrepVertex`, read-only
2424
The end vertex of this edge.
25-
vertices : list[:class:`~compas_rhino.geometry.RhinoBrepVertex`]
25+
vertices : list[:class:`~compas_rhino.geometry.RhinoBrepVertex`], read-only
2626
The list of vertices which comprise this edge (start and end)
2727
is_circle : bool, read-only
2828
True if the geometry of this edge is a circle, False otherwise.

src/compas_rhino/geometry/brep/face.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,13 @@ class RhinoBrepFace(BrepFace):
1111
----------
1212
native_surface : :class:`Rhino.Geometry.Surface`
1313
The rhino native underlying geometry of this face.
14-
loops : list[:class:`compas_rhino.geometry.RhinoBrepLoop`]
14+
loops : list[:class:`compas_rhino.geometry.RhinoBrepLoop`], read-only
1515
The list of loops which comprise this face.
1616
surface : :class:`compas_rhino.geometry.RhinoNurbsSurface`
1717
The compas_rhino wrapper of the underlying geometry of this face.
18-
boundary : :class:`compas_rhino.geometry.RhinoBrepLoop`
18+
boundary : :class:`compas_rhino.geometry.RhinoBrepLoop`, read-only
1919
The loop which defines the outer boundary of this face.
20-
holes : list[:class:`compas_rhino.geometry.RhinoBrepLoop`]
20+
holes : list[:class:`compas_rhino.geometry.RhinoBrepLoop`], read-only
2121
The list of loops which comprise the holes of this brep, if any.
2222
is_plane : float, read-only
2323
True if the geometry of this face is a plane, False otherwise.

src/compas_rhino/geometry/brep/loop.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,9 @@ class RhinoBrepLoop(BrepLoop):
3131
3232
Attributes
3333
----------
34-
edges : list[:class:`~compas_rhino.geometry.RhinoBrepLoop`]
34+
edges : list[:class:`~compas_rhino.geometry.RhinoBrepLoop`], read-only
3535
The list of edges which comprise this loop.
36-
loop_type : :class:`~compas_rhino.geometry.brep.loop.LoopType`
36+
loop_type : :class:`~compas_rhino.geometry.brep.loop.LoopType`, read-only
3737
The type of this loop.
3838
is_outer : bool, read-only
3939
True if this loop is an outer boundary, False otherwise.

src/compas_rhino/geometry/brep/vertex.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ class RhinoBrepVertex(BrepVertex):
88
99
Attributes
1010
----------
11-
point : :class:`~compas.geometry.Point`
11+
point : :class:`~compas.geometry.Point`, read-only
1212
The geometry of this vertex as a point in 3D space.
1313
1414
"""

0 commit comments

Comments
 (0)