Document statefulnes of CellIterator, closes #267 (#730)

Ferrite-FEM · May 26, 2023 · 0ec0e49 · 0ec0e49
1 parent e78ab28
commit 0ec0e49
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/src/iterators.jl b/src/iterators.jl
@@ -128,6 +128,9 @@ for idx in cellset
     # ...
 end
 ```
+!!! warning
+    `CellIterator` is stateful and should not be used for things other than `for`-looping
+    (e.g. broadcasting over, or collecting the iterator may yield unexpected results).
 """
 struct CellIterator{CC<:CellCache, IC<:IntegerCollection}
     cc::CC