chore: add doc to send_message call

interledger · Feb 5, 2020 · 5c49cd2 · 5c49cd2
1 parent 138ecc2
commit 5c49cd2
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/crates/interledger-settlement/src/core/settlement_client.rs b/crates/interledger-settlement/src/core/settlement_client.rs
@@ -41,6 +41,9 @@ impl SettlementClient {
         .await
     }
 
+    /// Sends a message to the engine (will retry idempotently if it fails) which will get forwarded to the peer's engine 
+    /// This is done by sending a POST to /accounts/:id/messages with the provided `message`
+    /// as the request's body
     pub async fn send_message(&self, id: Uuid, engine_url: Url, message: Vec<u8>) -> Response {
         FutureRetry::new(
             move || self.send_message_once(id.clone(), engine_url.clone(), message.clone()),