chore: update doc comments

aws-amplify · Apr 12, 2024 · e2e2ea4 · e2e2ea4
1 parent 9b8cbf7
commit e2e2ea4
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
diff --git a/packages/storage/amplify_storage_s3/example/integration_test/utils/sign_in_new_user.dart b/packages/storage/amplify_storage_s3/example/integration_test/utils/sign_in_new_user.dart
@@ -10,6 +10,8 @@ import 'tear_down.dart';
 /// Creates a new user and signs them in.
 ///
 /// Returns the users identityId.
+///
+/// A tear down will be added to delete the user after the test completes.
 Future<String> signInNewUser() async {
   addTearDownCurrentUser();
   final username = 'test-user-1-${uuid()}';

diff --git a/packages/storage/amplify_storage_s3/example/integration_test/utils/tear_down.dart b/packages/storage/amplify_storage_s3/example/integration_test/utils/tear_down.dart
@@ -19,6 +19,7 @@ void addTearDownPath(StoragePath path) {
   );
 }
 
+/// Adds a tear down to delete the current user.
 void addTearDownCurrentUser() {
   addTearDown(() {
     try {