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 javadoc regarding exception handling in async clients #5089

Merged
merged 2 commits into from
Apr 10, 2024
Merged

Update javadoc regarding exception handling in async clients #5089

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a181ce4
Update javadoc regarding exception handling in async clients
zoewangg Apr 9, 2024
38318fd
Fix tests
zoewangg Apr 9, 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
4 changes: 3 additions & 1 deletion codegen/src/main/java/software/amazon/awssdk/codegen/docs/DocumentationBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,9 @@ public final class DocumentationBuilder {
// TODO This prefix is not suitable for paginated operations. Either remove it for paginated operations
// or change the statement to something generic
private static final String ASYNC_THROWS_PREFIX = "The CompletableFuture returned by this method can be completed " +
"exceptionally with the following exceptions.";
"exceptionally with the following exceptions. The exception returned is "
zoewangg marked this conversation as resolved.
Show resolved Hide resolved
+ "wrapped with CompletionException, so you need to invoke {@link "
+ "Throwable#getCause} to retrieve the underlying exception.";

private String desc;
private List<Pair<String, String>> params = new ArrayList<>();
Expand Down
Loading