aljaz/lightning
1
0
Fork 0
mirror of https://github.com/aljazceru/lightning.git synced 2026-02-03 13:14:22 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: Mention that msatoshi on pay is not optional, but ignored

Browse Source 
Reported-by: Tim Horie <@thorie7912>
Signed-off-by: Christian Decker <@cdecker>
This commit is contained in:
Christian Decker
2018-11-13 00:54:51 +01:00
parent b02861bfe1
commit 6c649ce775
2 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
contrib/pylightning/lightning/lightning.py
View File

@@ -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)

4
lightningd/payalgo.c
View File

@@ -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%), "