Update orchestration.dart

dart-lang · Jul 21, 2023 · 2e099ab · 2e099ab
1 parent 6e3f57c
commit 2e099ab
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/pkgs/leak_tracker/lib/src/leak_tracking/orchestration.dart b/pkgs/leak_tracker/lib/src/leak_tracking/orchestration.dart
@@ -46,7 +46,10 @@ class MemoryLeaksDetectedError extends StateError {
 /// to analyse results.
 ///
 /// [gcCountBuffer] is number of full GC cycles, enough for a non reachable object to be GCed.
-///
+/// If after this number of GC cycles a disposed object is still not garbage collected,
+/// it is considered a notGCed leak.
+/// Theoretically, the value 1 should be enough, but in practice for stale applications
+/// it is too small. So, recommended value for applications is 3, and for tests is 1.
 ///
 /// If you test Flutter widgets, connect their instrumentation to the leak
 /// tracker: