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

Waiter documentation about error behavior is incorrect #4107

Closed
Shtutnik opened this issue Apr 30, 2024 · 2 comments · Fixed by #4108
Closed

Waiter documentation about error behavior is incorrect #4107

Shtutnik opened this issue Apr 30, 2024 · 2 comments · Fixed by #4108
Assignees
Labels
documentation This is a problem with documentation. p3 This is a minor priority issue waiters

Comments

@Shtutnik
Copy link

Describe the issue

Hi,

From what I see in the different waiter pages, it states that An error is **returned** ... although when checking the python code (for example here) it seems that actually an error is raised, not returned.

Could you please emphasize this so that developers know what behavior to expect from the wait function?

I listed some examples below, but I think this is a generic thing that applies to all waiter pages.

Links

https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ecs/waiter/ServicesStable.html
https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ec2/waiter/ImageExists.html

@Shtutnik Shtutnik added documentation This is a problem with documentation. needs-triage This issue or PR still needs to be triaged. labels Apr 30, 2024
@Shtutnik Shtutnik changed the title Waiter documentation behavior on error is incorrect Waiter documentation about error behavior is incorrect Apr 30, 2024
@tim-finnigan tim-finnigan self-assigned this Apr 30, 2024
@tim-finnigan tim-finnigan removed the needs-triage This issue or PR still needs to be triaged. label Apr 30, 2024
@tim-finnigan
Copy link
Contributor

Thanks for highlighting this. Per discussion with the team this is a reasonable wording change. I created the PR linked above (#4108) to update the wording.

@tim-finnigan tim-finnigan added waiters p3 This is a minor priority issue labels Apr 30, 2024
Copy link

This issue is now closed. Comments on closed issues are hard for our team to see.
If you need more assistance, please open a new issue that references this one.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation This is a problem with documentation. p3 This is a minor priority issue waiters
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants