oxidecomputer / oxidecomputer/third-party-api-clients
Improve `sheets::Client` docs
Open
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 150
- Forks
- 62
- PR merge metrics
- No merged PRs in 30d
Description
The current docs at https://docs.rs/sheets/latest/sheets/struct.Client.html are unclear. What do the parameters new takes mean? Which environment variables are read by new_from_env?
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the Client documentation at https://docs.rs/sheets/latest/sheets/struct.Client.html and inspect the descriptions for new and new_from_env. Update the documentation so the constructor parameters and environment variables read by new_from_env are explicit; done when both questions are answered on the docs page.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100