docs: add thrown exceptions to command documentation #715
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds the modeled errors of each operation to the JSDoc block of the corresponding command.
This will generate useful links in API documentation. The
@throws
entries appear directly after the existing links to the command input, output, and client config.The current documentation makes it impossible to find which exceptions are modeled with an operation without consulting the Smithy model declaration file. This will help API documentation readers or source code readers write their error handling switch cases.
Example: