From 105a88dde4d0261cb1025ab337a3a46913e0f7ff Mon Sep 17 00:00:00 2001 From: William Casarin Date: Fri, 3 Sep 2021 12:09:11 -0700 Subject: [PATCH] docs/fetchinvoice: document payer_note Signed-off-by: William Casarin --- doc/lightning-fetchinvoice.7 | 9 +++++++-- doc/lightning-fetchinvoice.7.md | 4 +++- 2 files changed, 10 insertions(+), 3 deletions(-) diff --git a/doc/lightning-fetchinvoice.7 b/doc/lightning-fetchinvoice.7 index c30cda4e0..ce68f6507 100644 --- a/doc/lightning-fetchinvoice.7 +++ b/doc/lightning-fetchinvoice.7 @@ -6,7 +6,7 @@ lightning-fetchinvoice - Command for fetch an invoice for an offer \fB(WARNING: experimental-offers only)\fR -\fBfetchinvoice\fR \fIoffer\fR [\fImsatoshi\fR] [\fIquantity\fR] [\fIrecurrence_counter\fR] [\fIrecurrence_start\fR] [\fIrecurrence_label\fR] [\fItimeout\fR] +\fBfetchinvoice\fR \fIoffer\fR [\fImsatoshi\fR] [\fIquantity\fR] [\fIrecurrence_counter\fR] [\fIrecurrence_start\fR] [\fIrecurrence_label\fR] [\fItimeout\fR] [\fIpayer_note\fR] .SH DESCRIPTION @@ -50,10 +50,14 @@ calls for the same recurrence, as it is used to link them together\. \fItimeout\fR is an optional timeout; if we don't get a reply before this we fail (default, 60 seconds)\. + +\fIpayer_note\fR is an optional payer note to include in the fetched invoice\. + .SH RETURN VALUE On success, an object is returned, containing: + .RS .IP \[bu] \fBinvoice\fR (string): The BOLT12 invoice we fetched @@ -94,6 +98,7 @@ On success, an object is returned, containing: The following error codes may occur: + .RS .IP \[bu] -1: Catchall nonspecific error\. @@ -119,4 +124,4 @@ Rusty Russell \fI is mainly responsible\. Main web site: \fIhttps://github.com/ElementsProject/lightning\fR -\" SHA256STAMP:8343ee7fe4d8413760a47a9d2657c4557734fa67af5bfec582daf780828ca675 +\" SHA256STAMP:278c8d05aa5412cd3dd58c2903d23b670e0666f2ac923d914f438d9808bd9ac8 diff --git a/doc/lightning-fetchinvoice.7.md b/doc/lightning-fetchinvoice.7.md index 7f45e4c56..613ab7d81 100644 --- a/doc/lightning-fetchinvoice.7.md +++ b/doc/lightning-fetchinvoice.7.md @@ -6,7 +6,7 @@ SYNOPSIS **(WARNING: experimental-offers only)** -**fetchinvoice** *offer* \[*msatoshi*\] \[*quantity*\] \[*recurrence_counter*\] \[*recurrence_start*\] \[*recurrence_label*\] \[*timeout*\] +**fetchinvoice** *offer* \[*msatoshi*\] \[*quantity*\] \[*recurrence_counter*\] \[*recurrence_start*\] \[*recurrence_label*\] \[*timeout*\] \[*payer_note*\] DESCRIPTION ----------- @@ -43,6 +43,8 @@ calls for the same recurrence, as it is used to link them together. *timeout* is an optional timeout; if we don't get a reply before this we fail (default, 60 seconds). +*payer_note* is an optional payer note to include in the fetched invoice. + RETURN VALUE ------------