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.

Sign up for GitHub

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 #4108

Merged
merged 2 commits into from
Apr 30, 2024
Merged

Update waiter description #4108

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8adde74
replaced returned with raised in waiter description
tim-finnigan Apr 30, 2024
bd0cc9f
update tests to match new waiter description
tim-finnigan Apr 30, 2024
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 boto3/docs/waiter.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:]),
Expand Down
2 changes: 1 addition & 1 deletion tests/unit/docs/test_docstring.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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**',
' ::',
Expand Down
2 changes: 1 addition & 1 deletion tests/unit/docs/test_waiter.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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**',
' ::',
Expand Down
Loading