From 6c649ce775640d476764ff22114534b4feb6bf38 Mon Sep 17 00:00:00 2001 From: Christian Decker Date: Tue, 13 Nov 2018 00:54:51 +0100 Subject: [PATCH] docs: Mention that msatoshi on pay is not optional, but ignored Reported-by: Tim Horie <@thorie7912> Signed-off-by: Christian Decker <@cdecker> --- contrib/pylightning/lightning/lightning.py | 4 ++-- lightningd/payalgo.c | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/contrib/pylightning/lightning/lightning.py b/contrib/pylightning/lightning/lightning.py index 2854849cd..d72a03c58 100644 --- a/contrib/pylightning/lightning/lightning.py +++ b/contrib/pylightning/lightning/lightning.py @@ -285,8 +285,8 @@ class LightningRpc(UnixDomainSocketRpc): def pay(self, bolt11, msatoshi=None, description=None, riskfactor=None): """ - Send payment specified by {bolt11} with optional {msatoshi} - (if and only if {bolt11} does not have amount), + Send payment specified by {bolt11} with {msatoshi} + (ignored if {bolt11} has an amount), {description} (required if {bolt11} uses description hash) and {riskfactor} (default 1.0) diff --git a/lightningd/payalgo.c b/lightningd/payalgo.c index c0e3cbe4b..fe78a6942 100644 --- a/lightningd/payalgo.c +++ b/lightningd/payalgo.c @@ -695,8 +695,8 @@ static void json_pay(struct command *cmd, static const struct json_command pay_command = { "pay", json_pay, - "Send payment specified by {bolt11} with optional {msatoshi} " - "(if and only if {bolt11} does not have amount), " + "Send payment specified by {bolt11} with {msatoshi} " + "(ignored if {bolt11} has an amount), " "{description} (required if {bolt11} uses description hash), " "{riskfactor} (default 1.0), " "{maxfeepercent} (default 0.5) the maximum acceptable fee as a percentage (e.g. 0.5 => 0.5%), "