Update waiter description (#4108)

boto · Apr 30, 2024 · b61f7f9 · b61f7f9
1 parent fd8eece
commit b61f7f9
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 3 deletions.
diff --git a/boto3/docs/waiter.py b/boto3/docs/waiter.py
@@ -92,7 +92,7 @@ def document_resource_waiter(
         'Waits until this {} is {}. This method calls '
         ':py:meth:`{}.Waiter.{}.wait` which polls '
         ':py:meth:`{}.Client.{}` every {} seconds until '
-        'a successful state is reached. An error is returned '
+        'a successful state is reached. An error is raised '
         'after {} failed checks.'.format(
             resource_name,
             ' '.join(resource_waiter_model.name.split('_')[2:]),

diff --git a/tests/unit/docs/test_docstring.py b/tests/unit/docs/test_docstring.py
@@ -274,7 +274,7 @@ def test_resource_waiter_help(self):
                     ':py:meth:`MyService.Waiter.sample_operation_complete.wait` '
                     'which polls :py:meth:`MyService.Client.sample_operation` every '
                     '15 seconds until a successful state is reached. An error '
-                    'is returned after 40 failed checks.'
+                    'is raised after 40 failed checks.'
                 ),
                 '    **Request Syntax**',
                 '    ::',

diff --git a/tests/unit/docs/test_waiter.py b/tests/unit/docs/test_waiter.py
@@ -41,7 +41,7 @@ def test_document_resource_waiters(self):
                     ':py:meth:`MyService.Waiter.sample_operation_complete.wait` '
                     'which polls :py:meth:`MyService.Client.sample_operation` '
                     'every 15 seconds until a successful state is reached. An '
-                    'error is returned after 40 failed checks.'
+                    'error is raised after 40 failed checks.'
                 ),
                 '  **Request Syntax**',
                 '  ::',