doc: Clarify listpeerchannels documentation. #7155
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
evansmj
changed the title
|
Wait until #6995 is merged |
vincenzopalazzo
suggested changes
Mar 19, 2024
| @@ -9,7 +9,7 @@ SYNOPSIS | |||
| DESCRIPTION | |||
| ----------- | |||
|
|
|||
| The **listpeerchannels** RPC command returns data on channels of the network, with the possibility to filter the channels by node id. | |||
| The **listpeerchannels** RPC command returns data on this node's channels, with the possibility to filter the channels by the id of a remote node. | |||
There was a problem hiding this comment.
idk if this is clear, maybe it is. However, listpeerchannels return the list of channels inside the network divided by peers.
e.g:
peer -> channels
peer -> channels
|
Closing in favour of PR #7326. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is to clarify the listpeerchannels documentation. I had been reading it as though listpeerchannels returns all channels in the network, which while developing a frontend did not make sense so I spent time testing in startup_regtest.sh to figure out what it really does. I think this clarification would help others in the future.