Explain how the scroll controller behaves under tests (#50129)

20327605 · David Shuckerow · GitHub · f8b286dc · 20327605
Unverified Commit 20327605 authored Feb 06, 2020 by David Shuckerow Committed by GitHub Feb 06, 2020
Hide whitespace changes
Inline Side-by-side

Showing with 4 additions and 0 deletions

scroll_controller.dart packages/flutter/lib/src/widgets/scroll_controller.dart +4 -0

No files found.
--- a/packages/flutter/lib/src/widgets/scroll_controller.dart
+++ b/packages/flutter/lib/src/widgets/scroll_controller.dart
@@ -142,6 +142,10 @@ class ScrollController extends ChangeNotifier {
  ///
  /// The duration must not be zero. To jump to a particular value without an
  /// animation, use [jumpTo].
+  ///
+  /// When calling [animateTo] in widget tests, `await`ing the returned
+  /// [Future] may cause the test to hang and timeout. Instead, use
+  /// [WidgetTester.pumpAndSettle].
  Future<void> animateTo(
    double offset, {
    @required Duration duration,