Skip to content

Commit

Permalink
doc: Fix typo in the description of fields private
Browse files Browse the repository at this point in the history
Signed-off-by: Peter Neuroth <[email protected]>
[ Regenerated man pages --RR ]
  • Loading branch information
nepet authored and rustyrussell committed Aug 8, 2023
1 parent 1fbe87f commit 29fea55
Show file tree
Hide file tree
Showing 6 changed files with 9 additions and 9 deletions.
4 changes: 2 additions & 2 deletions doc/lightning-listclosedchannels.7.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ On success, an object containing **closedchannels** is returned. It is an array

- **channel\_id** (hash): The full channel\_id (funding txid Xored with output number)
- **opener** (string): Who initiated the channel (one of "local", "remote")
- **private** (boolean): if False, we will not announce this channel
- **private** (boolean): if True, we will not announce this channel
- **total\_local\_commitments** (u64): Number of commitment transaction we made
- **total\_remote\_commitments** (u64): Number of commitment transaction they made
- **total\_htlcs\_sent** (u64): Number of HTLCs we ever sent
Expand Down Expand Up @@ -76,4 +76,4 @@ RESOURCES

Main web site: <https://github.com/ElementsProject/lightning> Lightning

[comment]: # ( SHA256STAMP:0c368cb41f46a2124e9b3f0b760494d1f4b9c3b248267f56b887fbf96f26e176)
[comment]: # ( SHA256STAMP:3020e068d48a43494983df1a902d7483a52d0c41faef85e6d858dcf7c64c188d)
4 changes: 2 additions & 2 deletions doc/lightning-listpeerchannels.7.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ On success, an object containing **channels** is returned. It is an array of ob
- **our\_funding\_msat** (msat): amount we have in the channel
- **scratch\_txid** (txid): The commitment transaction txid we would use if we went onchain now
- **close\_to** (hex, optional): scriptPubkey which we have to close to if we mutual close
- **private** (boolean, optional): if False, we will not announce this channel
- **private** (boolean, optional): if True, we will not announce this channel
- **closer** (string, optional): Who initiated the channel close (only present if closing) (one of "local", "remote")
- **funding** (object, optional):
- **local\_funds\_msat** (msat): Amount of channel we funded
Expand Down Expand Up @@ -196,4 +196,4 @@ Main web site: <https://github.com/ElementsProject/lightning> Lightning
RFC site (BOLT \#9):
<https://github.com/lightningnetwork/lightning-rfc/blob/master/09-features.md>

[comment]: # ( SHA256STAMP:dade32248bd309f2514a237cb71be6ddbe12220e1b6899693a032b45b7980a01)
[comment]: # ( SHA256STAMP:359d0035f98350d2de5f539ce8d2c3d82ccf633d3cbee4ed992a71687a25770a)
4 changes: 2 additions & 2 deletions doc/lightning-listpeers.7.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ On success, an object containing **peers** is returned. It is an array of objec
- **splice\_amount** (integer): The amouont of sats we're splicing in or out *(added v23.08)*
- **scratch\_txid** (txid): The commitment transaction txid we would use if we went onchain now
- **close\_to** (hex, optional): scriptPubkey which we have to close to if we mutual close
- **private** (boolean, optional): if False, we will not announce this channel
- **private** (boolean, optional): if True, we will not announce this channel
- **closer** (string, optional): Who initiated the channel close (one of "local", "remote")
- **funding** (object, optional):
- **local\_funds\_msat** (msat): Amount of channel we funded
Expand Down Expand Up @@ -399,4 +399,4 @@ Main web site: <https://github.com/ElementsProject/lightning> Lightning
RFC site (BOLT \#9):
<https://github.com/lightning/bolts/blob/master/09-features.md>

[comment]: # ( SHA256STAMP:d75b5070288f26a39df39831212f40c397f1389e7c1765f22829d3f3389a56aa)
[comment]: # ( SHA256STAMP:7402bcd43be7c031c1e8e1ec7a4d58e94beb44ca48ba2f8f06e4ea908ab8940b)
2 changes: 1 addition & 1 deletion doc/schemas/listclosedchannels.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@
},
"private": {
"type": "boolean",
"description": "if False, we will not announce this channel"
"description": "if True, we will not announce this channel"
},
"channel_type": {
"type": "object",
Expand Down
2 changes: 1 addition & 1 deletion doc/schemas/listpeerchannels.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -199,7 +199,7 @@
},
"private": {
"type": "boolean",
"description": "if False, we will not announce this channel"
"description": "if True, we will not announce this channel"
},
"opener": {
"type": "string",
Expand Down
2 changes: 1 addition & 1 deletion doc/schemas/listpeers.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -315,7 +315,7 @@
},
"private": {
"type": "boolean",
"description": "if False, we will not announce this channel"
"description": "if True, we will not announce this channel"
},
"opener": {
"type": "string",
Expand Down

0 comments on commit 29fea55

Please sign in to comment.