googleapis / googleapis/gapic-generator-go
Include retry info in client and/or method docs
Open
priority: p3
type: feature request
- Dominant language
- Go
- Stars
- 305
- Forks
- 60
- Avg merge
- 1d 8h
- Merged PRs (30d)
- 13
Description
It would be nice to have more information about retries in the GoDoc of the libraries:
* What is retried by default?
* How exactly do I configure retries?
Contributor guide
Research direction
Start by locating the GoDoc templates or generator entry points that produce client and method documentation, then inspect how retry defaults and configuration are represented in generated libraries. Done means the relevant GoDoc explains what is retried by default and how callers configure retries, with documentation tests or generated-output checks updated if present.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100