rpc: Add function comments for get_clients.

chainwayxyz · Dec 6, 2024 · 4988969 · 4988969
1 parent 3c392ac
commit 4988969
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/core/src/rpc/mod.rs b/core/src/rpc/mod.rs
@@ -11,6 +11,16 @@ pub mod verifier;
 pub mod watchtower;
 mod wrapper;
 
+/// Returns gRPC clients.
+///
+/// # Parameters
+///
+/// - `endpoints`: URIs for clients
+/// - `connect`: Function that will be used to initiate gRPC connection
+///
+/// # Returns
+///
+/// - [`CLIENT`]: [`tonic`] gRPC client.
 pub async fn get_clients<CLIENT, F, Fut>(
     endpoints: Vec<String>,
     connect: F,