warn about flatten_results! behavior in docs

JuliaTesting · Jun 10, 2024 · 7b90fe3 · 7b90fe3
1 parent fa124ec
commit 7b90fe3
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/src/testsets.jl b/src/testsets.jl
@@ -263,6 +263,9 @@ end
 
 Returns a flat vector of `TestSet`s which only contain `Result`s. This is necessary for
 writing a JUnit XML report the schema does not allow nested XML `testsuite` elements.
+
+Warning: Alters the original hierarchy inside `ts` and potentially removes testsets
+         from it. Be sure to rely only on the returned vector after usage.
 """
 flatten_results!(ts::AbstractTestSet) = _flatten_results!(ts, 0)