google / google/tarpc

Documentation improvements

Open
#57 7 comments 1 reaction 1 assignee Claimed by @shaladdle View on GitHub
documentation
Dominant language
Rust
Stars
3.7k
Forks
230
PR merge metrics
No merged PRs in 30d

Description

@jonhoo @tikue
- Explain `|` syntax
- Write more about services and clients and when you might return what errors. Have some examples.
- Make it more clear that service implementations must be `Clone`/`Send`/`'static`
- Add to the readme
- Add to the macro documentation if it's not there
- Warn of the dangers of mixing `FutureService` with `SyncClient`
- Namely, if the client runs on the same thread as the service's reactor, things hang
- choose crates.io [categories](https://crates.io/categories)
- Clearly specify the costs of sync services

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.