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

Jump to bottom

Add document generation for operations #1033

Closed
jbelkins opened this issue Jun 6, 2023 · 1 comment
Closed

Add document generation for operations #1033

jbelkins opened this issue Jun 6, 2023 · 1 comment
Assignees
@sichanyoo
Labels
amplify Related to aws-amplify/amplify-swift documentation This is a problem with documentation.

Comments

@jbelkins
Copy link
Contributor

jbelkins commented Jun 6, 2023

Describe the issue

Operations should include, in their inline documentation, a code-generated list of the service and operation errors they can potentially throw, located in the "Throws" section.

Links

N/A
@jbelkins jbelkins added documentation This is a problem with documentation. needs-triage This issue or PR still needs to be triaged. amplify Related to aws-amplify/amplify-swift labels Jun 6, 2023
@jbelkins jbelkins added good first issue and removed needs-triage This issue or PR still needs to be triaged. labels Jun 19, 2023
@sichanyoo sichanyoo self-assigned this Aug 9, 2023
@sichanyoo sichanyoo mentioned this issue Aug 10, 2023
Merged
2 tasks
@sichanyoo sichanyoo changed the title Add error info to code-generated operation docs Add document generation for operations Aug 14, 2023
@jbelkins
Copy link
Contributor Author

Shipped in AWS SDK for Swift 0.23.0

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@sichanyoo sichanyoo

Labels
amplify Related to aws-amplify/amplify-swift documentation This is a problem with documentation.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@jbelkins @sichanyoo