Merge pull request #3196 from tim-finnigan/update-waiter-description

Update waiter description: change `returned` to `raised` for accuracy
boto · Aug 19, 2024 · 53abee4 · 53abee4
2 parents 98899c0 + e0f04ab
commit 53abee4
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 3 deletions.
diff --git a/botocore/docs/waiter.py b/botocore/docs/waiter.py
@@ -164,7 +164,7 @@ def document_wait_method(
         f'Polls :py:meth:`{get_service_module_name(service_model)}.Client.'
         f'{xform_name(waiter_model.operation)}` every {waiter_model.delay} '
         'seconds until a successful state is reached. An error is '
-        f'returned after {waiter_model.max_attempts} failed checks.'
+        f'raised after {waiter_model.max_attempts} failed checks.'
     )
 
     document_model_driven_method(

diff --git a/tests/unit/docs/test_waiter.py b/tests/unit/docs/test_waiter.py
@@ -47,7 +47,7 @@ def test_document_waiters(self):
                 (
                     '    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/test_waiters.py b/tests/unit/test_waiters.py
@@ -801,7 +801,7 @@ def test_waiter_help_documentation(self):
             (
                 '    Polls :py:meth:`MyService.Client.foo` every 1 '
                 'seconds until a successful state is reached. An error '
-                'is returned after 1 failed checks.'
+                'is raised after 1 failed checks.'
             ),
             '    **Request Syntax**',
             '    ::',