From: Jeffrey Czyz <jkczyz@gmail.com>
Date: Fri, 8 Dec 2023 04:25:25 +0000 (-0600)
Subject: Fix create_onion_message return type documentation
X-Git-Tag: v0.0.119~20^2~2
X-Git-Url: http://git.bitcoin.ninja/?a=commitdiff_plain;h=5892fd698ed376af774d3cba5bcf0f97ae53d480;p=rust-lightning

Fix create_onion_message return type documentation
---

diff --git a/lightning/src/onion_message/messenger.rs b/lightning/src/onion_message/messenger.rs
index 05ea7a285..52acc20d4 100644
--- a/lightning/src/onion_message/messenger.rs
+++ b/lightning/src/onion_message/messenger.rs
@@ -459,7 +459,8 @@ pub enum PeeledOnion<T: OnionMessageContents> {
 /// Creates an [`OnionMessage`] with the given `contents` for sending to the destination of
 /// `path`.
 ///
-/// Returns both the node id of the peer to send the message to and the message itself.
+/// Returns the node id of the peer to send the message to, the message itself, and any addresses
+/// need to connect to the first node.
 pub fn create_onion_message<ES: Deref, NS: Deref, T: OnionMessageContents>(
 	entropy_source: &ES, node_signer: &NS, secp_ctx: &Secp256k1<secp256k1::All>,
 	path: OnionMessagePath, contents: T, reply_path: Option<BlindedPath>,