Skip to content

Commit f23d3ad

Browse files
committed
add docstring
1 parent 7a0c400 commit f23d3ad

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

src/GeometryBasics.jl

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,18 @@ struct Mesh{
168168
simplices::V
169169
end
170170

171-
171+
"""
172+
FaceView enables to link one array of points via a face array, to generate one
173+
abstract array of elements.
174+
E.g., this becomes possible:
175+
```
176+
x = FaceView(rand(Point3f0, 10), TriangleFace[(1, 2, 3), (2,4, 5), ...])
177+
x[1] isa Triangle == true
178+
x isa AbstractVector{<: Triangle} == true
179+
# This means we can use it as a mesh:
180+
Mesh(x) # should just work!
181+
```
182+
"""
172183
struct FaceView{
173184
Element,
174185
Point <: AbstractPoint,

0 commit comments

Comments
 (0)