Leave some notes

github · tclem · Jul 23, 2025 · Jul 11, 2025 · Jul 11, 2025 · Jul 11, 2025
commit f4250971ee825277e203ce1cd8c77cb5412e0743
@@ -25,6 +25,17 @@ async fn ping() -> &'static str {
     "Pong\n"
 }
 
+/// You can run this end-to-end example by running both a server and a client and observing the requests/responses.
+///
+/// 1. Run the server:
+/// ```sh
+/// cargo run --bin advanced-server
+/// ```
+///
+/// 2. In another shell, run the client:
+/// ```sh
+/// cargo run --bin client
+/// ```
 #[tokio::main]
 pub async fn main() {
     let api_impl = HaberdasherApiServer {};

@@ -15,6 +15,17 @@ use service::haberdash::v1::{
     GetStatusRequest, GetStatusResponse, HaberdasherApi, MakeHatRequest, MakeHatResponse,
 };
 
+/// You can run this end-to-end example by running both a server and a client and observing the requests/responses.
+///
+/// 1. Run the server:
+/// ```sh
+/// cargo run --bin advanced-server # OR cargo run --bin simple-server
+/// ```
+///
+/// 2. In another shell, run the client:
+/// ```sh
+/// cargo run --bin client
+/// ```
 #[tokio::main]
 pub async fn main() -> Result<(), GenericError> {
     // basic client

@@ -20,6 +20,17 @@ async fn ping() -> &'static str {
     "Pong\n"
 }
 
+/// You can run this end-to-end example by running both a server and a client and observing the requests/responses.
+///
+/// 1. Run the server:
+/// ```sh
+/// cargo run --bin simple-server
+/// ```
+///
+/// 2. In another shell, run the client:
+/// ```sh
+/// cargo run --bin client
+/// ```
 #[tokio::main]
 pub async fn main() {
     let api_impl = HaberdasherApiServer {};