document the order

FluxML · Oct 5, 2021 · c1c2421 · c1c2421
1 parent b020163
commit c1c2421
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/src/functor.jl b/src/functor.jl
@@ -149,7 +149,8 @@ fmapstructure(f, x; kwargs...) = fmap(f, x; walk = (f, x) -> map(f, children(x))
     fcollect(x; exclude = v -> false)
 
 Traverse `x` by recursing each child of `x` as defined by [`functor`](@ref)
-and collecting the results into a flat array.
+and collecting the results into a flat array, ordered by a breadth-first
+traversal of `x`, respecting the iteration order of `children` calls.
 
 Doesn't recurse inside branches rooted at nodes `v`
 for which `exclude(v) == true`.