Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update waiter description: change returned to raised for accuracy #3196

Merged
merged 2 commits into from
Aug 19, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion botocore/docs/waiter.py
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ def document_wait_method(
wait_description = (
'Polls :py:meth:`{}.Client.{}` every {} '
'seconds until a successful state is reached. An error is '
'returned after {} failed checks.'.format(
'raised after {} failed checks.'.format(
get_service_module_name(service_model),
xform_name(waiter_model.operation),
waiter_model.delay,
Expand Down
2 changes: 1 addition & 1 deletion tests/unit/docs/test_waiter.py
Original file line number Diff line number Diff line change
Expand Up @@ -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**',
' ::',
Expand Down
2 changes: 1 addition & 1 deletion tests/unit/test_waiters.py
Original file line number Diff line number Diff line change
Expand Up @@ -769,7 +769,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**',
' ::',
Expand Down
Loading