From b61f7f90710ea427af61df79a9e7924a8542a000 Mon Sep 17 00:00:00 2001 From: Tim Finnigan <87778557+tim-finnigan@users.noreply.github.com> Date: Tue, 30 Apr 2024 12:22:58 -0700 Subject: [PATCH] Update waiter description (#4108) --- boto3/docs/waiter.py | 2 +- tests/unit/docs/test_docstring.py | 2 +- tests/unit/docs/test_waiter.py | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/boto3/docs/waiter.py b/boto3/docs/waiter.py index a135d972e7..54a63b1cc3 100644 --- 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 index d2a9f3fa89..ce61505a9d 100644 --- 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 index ecfd884caf..3a2b8e09a5 100644 --- 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**', ' ::',