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

Closed
Shtutnik opened this issue Jun 1, 2024 · 2 comments · Fixed by #3196
Closed

Waiter documentation about error behavior is incorrect #3193

Shtutnik opened this issue Jun 1, 2024 · 2 comments · Fixed by #3196
Labels
documentation This is a problem with documentation. p2 This is a standard priority issue waiter

Comments

@Shtutnik
Copy link

Shtutnik commented Jun 1, 2024

Describe the issue

Hi,

(Also opened this issue that was merged)

From what I see in the different waiter pages, it states that An error is returned (see code here) ... 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 Jun 1, 2024
@tim-finnigan tim-finnigan self-assigned this Jun 4, 2024
@tim-finnigan tim-finnigan added the investigating This issue is being investigated and/or work is in progress to resolve the issue. label Jun 4, 2024
@tim-finnigan
Copy link
Contributor

Thanks for following up here, created #3196 which should address this.

@tim-finnigan tim-finnigan added p2 This is a standard priority issue and removed investigating This issue is being investigated and/or work is in progress to resolve the issue. needs-triage This issue or PR still needs to be triaged. labels Jun 4, 2024
@tim-finnigan tim-finnigan removed their assignment Jun 4, 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. p2 This is a standard priority issue waiter
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants