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

after-call documentation doesn't match behavior #4344

Open
zastrowm opened this issue Nov 12, 2024 · 1 comment
Open

after-call documentation doesn't match behavior #4344

zastrowm opened this issue Nov 12, 2024 · 1 comment
Assignees
Labels
documentation This is a problem with documentation. p3 This is a minor priority issue response-requested Waiting on additional information or feedback.

Comments

@zastrowm
Copy link

Describe the issue

The documentation for the after-call hook says:

8 * - after-call is emitted when a successful API response is received.

which seems to indicate that unsuccessful API responses would not invoke the hook. However, I've observed that the hook gets invoked even for unsuccessful API responses and the code itself seems to indicate that it's invoked for all responses.

It seems like the docs should be updated to indicate that it's emitted for both successful and unsuccessful API responses.

Links

https://boto3.amazonaws.com/v1/documentation/api/latest/guide/events.html#boto3-specific-events

@zastrowm zastrowm added documentation This is a problem with documentation. needs-triage This issue or PR still needs to be triaged. labels Nov 12, 2024
@adev-code adev-code self-assigned this Nov 13, 2024
@adev-code adev-code added investigating This issue is being investigated and/or work is in progress to resolve the issue. p3 This is a minor priority issue and removed needs-triage This issue or PR still needs to be triaged. labels Nov 13, 2024
@adev-code
Copy link

Hello @zastrowm, thank you for reaching out and finding out improvement on the documentation. I have reached out to the documentation team for the fixed. Please let me know if you have any further questions. Thank you.

For internal use only: P171570557

@adev-code adev-code added response-requested Waiting on additional information or feedback. and removed investigating This issue is being investigated and/or work is in progress to resolve the issue. labels Nov 20, 2024
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 response-requested Waiting on additional information or feedback.
Projects
None yet
Development

No branches or pull requests

2 participants