Skip to content

Commit 1124ae1

Browse files
committed
f - expand payer_note docs
1 parent c273365 commit 1124ae1

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

lightning/src/offers/invoice_request.rs

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,8 @@ impl<'a> InvoiceRequestBuilder<'a> {
139139
self
140140
}
141141

142-
/// Sets a note for the invoice request.
142+
/// Sets a payer-defined note which will be seen by recipient and reflected in the invoice
143+
/// response.
143144
///
144145
/// Successive calls to this method will override the previous setting.
145146
pub fn payer_note(mut self, payer_note: String) -> Self {
@@ -292,7 +293,7 @@ impl InvoiceRequest {
292293
self.contents.payer_id
293294
}
294295

295-
/// Payer provided note to include in the invoice.
296+
/// Payer-provided note to include in the invoice.
296297
pub fn payer_note(&self) -> Option<PrintableString> {
297298
self.contents.payer_note.as_ref().map(|payer_note| PrintableString(payer_note.as_str()))
298299
}

0 commit comments

Comments
 (0)