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

Add example docs to APIError package #228

Closed
tritone opened this issue Sep 19, 2022 · 0 comments · Fixed by googleapis/gapic-generator-go#1333
Closed

Add example docs to APIError package #228

tritone opened this issue Sep 19, 2022 · 0 comments · Fixed by googleapis/gapic-generator-go#1333
Assignees
Labels
priority: p3 Desirable enhancement or fix. May not be included in next release. type: docs Improvement to the documentation for an API.

Comments

@tritone
Copy link

tritone commented Sep 19, 2022

There are good examples for how to unpack and use APIError in the google-cloud-go docs. However, if a user looks up the APIError type directly, there is not any clarity on how to use it in the docs for the package, which might be confusing. We should add similar docs there, or maybe link to the google-cloud-go docs in question.

Alternatively (or additionally), it also might be worth added a section on error handling using APIError to the auto-generated doc.go files for GAPIC clients for easier discoverability.

@tritone tritone added type: docs Improvement to the documentation for an API. priority: p3 Desirable enhancement or fix. May not be included in next release. labels Sep 19, 2022
@codyoss codyoss self-assigned this May 19, 2023
codyoss added a commit to codyoss/gapic-generator-go that referenced this issue May 19, 2023
codyoss added a commit that referenced this issue May 19, 2023
codyoss added a commit to googleapis/gapic-generator-go that referenced this issue May 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority: p3 Desirable enhancement or fix. May not be included in next release. type: docs Improvement to the documentation for an API.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants