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

Documentation and Code Example Overhaul #194

Open
3 tasks
blowmage opened this issue Apr 16, 2019 · 0 comments
Open
3 tasks

Documentation and Code Example Overhaul #194

blowmage opened this issue Apr 16, 2019 · 0 comments
Assignees
@blowmage
Labels
type: docs Improvement to the documentation for an API.

Comments

@blowmage
Copy link
Contributor

We need to pass over all the documentation to do the following:

  • Maintain a consistent voice
  • Ensure all public methods are documented
  • Add code examples showing expected usage
@blowmage blowmage transferred this issue from googleapis/gax-ruby Aug 7, 2019
@yoshi-automation yoshi-automation added 🚨 This issue needs some love. triage me I really want to be triaged. labels Aug 7, 2019
@blowmage blowmage added the type: docs Improvement to the documentation for an API. label Sep 6, 2019
@yoshi-automation yoshi-automation removed 🚨 This issue needs some love. triage me I really want to be triaged. labels Sep 6, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@blowmage blowmage

Labels
type: docs Improvement to the documentation for an API.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@blowmage @yoshi-automation