Skip to content

Commit d15236d

Browse files
committed
Properly document the initialized Future.
1 parent 28e1a06 commit d15236d

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

packages/google_sign_in/google_sign_in_web/lib/google_sign_in_web.dart

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,6 @@ class GoogleSignInPlugin extends GoogleSignInPlatform {
4444
/// Constructs the plugin immediately and begins initializing it in the
4545
/// background.
4646
///
47-
/// The plugin is completely initialized when [initialized] completed.
48-
///
4947
/// For tests, the plugin can skip its loading process with [debugOverrideLoader],
5048
/// and the implementation of the underlying GIS SDK client through [debugOverrideGisSdkClient].
5149
GoogleSignInPlugin({
@@ -97,7 +95,10 @@ class GoogleSignInPlugin extends GoogleSignInPlatform {
9795
}
9896
}
9997

100-
/// A future that resolves when the SDK has been correctly loaded.
98+
/// A future that resolves when the plugin is fully initialized.
99+
///
100+
/// This ensures that the SDK has been loaded, and that the `initWithParams`
101+
/// method has finished running.
101102
@visibleForTesting
102103
Future<void> get initialized {
103104
_assertIsInitCalled();

0 commit comments

Comments
 (0)