Skip to content

Commit 9e6f0ef

Browse files
authored
Merge pull request #6644 from guggero/connect-peer-request-comment
lnrpc: fix comment and formatting in ConnectPeerRequest [skip ci]
2 parents 0671060 + c492f36 commit 9e6f0ef

File tree

3 files changed

+19
-13
lines changed

3 files changed

+19
-13
lines changed

lnrpc/lightning.pb.go

+7-5
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

lnrpc/lightning.proto

+9-5
Original file line numberDiff line numberDiff line change
@@ -1008,11 +1008,11 @@ message OutPoint {
10081008
}
10091009

10101010
message LightningAddress {
1011-
// The identity pubkey of the Lightning node
1011+
// The identity pubkey of the Lightning node.
10121012
string pubkey = 1;
10131013

10141014
// The network location of the lightning node, e.g. `69.69.69.69:1337` or
1015-
// `localhost:10011`
1015+
// `localhost:10011`.
10161016
string host = 2;
10171017
}
10181018

@@ -1201,11 +1201,15 @@ message VerifyMessageResponse {
12011201
}
12021202

12031203
message ConnectPeerRequest {
1204-
// Lightning address of the peer, in the format `<pubkey>@host`
1204+
/*
1205+
Lightning address of the peer to connect to.
1206+
*/
12051207
LightningAddress addr = 1;
12061208

1207-
/* If set, the daemon will attempt to persistently connect to the target
1208-
* peer. Otherwise, the call will be synchronous. */
1209+
/*
1210+
If set, the daemon will attempt to persistently connect to the target
1211+
peer. Otherwise, the call will be synchronous.
1212+
*/
12091213
bool perm = 2;
12101214

12111215
/*

lnrpc/lightning.swagger.json

+3-3
Original file line numberDiff line numberDiff line change
@@ -3901,7 +3901,7 @@
39013901
"properties": {
39023902
"addr": {
39033903
"$ref": "#/definitions/lnrpcLightningAddress",
3904-
"title": "Lightning address of the peer, in the format `\u003cpubkey\u003e@host`"
3904+
"description": "Lightning address of the peer to connect to."
39053905
},
39063906
"perm": {
39073907
"type": "boolean",
@@ -4935,11 +4935,11 @@
49354935
"properties": {
49364936
"pubkey": {
49374937
"type": "string",
4938-
"title": "The identity pubkey of the Lightning node"
4938+
"description": "The identity pubkey of the Lightning node."
49394939
},
49404940
"host": {
49414941
"type": "string",
4942-
"title": "The network location of the lightning node, e.g. `69.69.69.69:1337` or\n`localhost:10011`"
4942+
"description": "The network location of the lightning node, e.g. `69.69.69.69:1337` or\n`localhost:10011`."
49434943
}
49444944
}
49454945
},

0 commit comments

Comments
 (0)