grpc-protobuf: move client exports to a submodule - #2817
Conversation
e143e75 to
131f2f7
Compare
| //! There are four basic RPC (Remote Procedure Call) types and a corresponding | ||
| //! call builder for each. |
There was a problem hiding this comment.
This is all assuming client-side stuff only and will want to be rewritten at least when we add the server symbols, or now if you want to do it. We can either document all the client and server stuff together in here, or we can move this into the client module and leave something else useful behind for the top level.
There was a problem hiding this comment.
Moved the docs to the client module and added a Modules section in its place, similar to the grpc crate.
dfawley
left a comment
dfawley
left a comment
There was a problem hiding this comment.
Just a couple tiny nits otherwise LGTM
| * | ||
| */ | ||
|
|
||
| //! Types and call builders for client-side RPCs. |
There was a problem hiding this comment.
Super-nit: there isn't really a thing that is a "client-side RPC". I'd probably do:
//! Client-side types and call builders for RPCs (Remote Procedure Calls).
| //! | ||
| //! # Basic usage | ||
| //! | ||
| //! There are four basic RPC (Remote Procedure Call) types and a corresponding |
There was a problem hiding this comment.
Nit: move the definition of the term to the first use.
| //! the call. Each one also provides an [`IntoFuture`] implementation to | ||
| //! actually begin the call. See the documentation for each type for additional | ||
| //! usage information. | ||
| //! * [`client`] - Types and call builders for client-side RPCs |
There was a problem hiding this comment.
Same nit here: Client-side types and call builders for RPCs.
2 participants
Why
If both client and server symbols are exported directly from the crate root, it can lead to name collisions. Client symbols must now be imported from
grpc_protobuf::clientand server symbols will be exported fromgrpc_protobuf::server.