Skip to content

Commit 3069b56

Browse files
committed
[doc] Improve help for getpeerinfo connection_type field.
1 parent 875e1cc commit 3069b56

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

src/rpc/net.cpp

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,9 @@ static RPCHelpMan getpeerinfo()
118118
{RPCResult::Type::BOOL, "inbound", "Inbound (true) or Outbound (false)"},
119119
{RPCResult::Type::BOOL, "addnode", "Whether connection was due to addnode/-connect or if it was an automatic/inbound connection\n"
120120
"(DEPRECATED, returned only if the config option -deprecatedrpc=getpeerinfo_addnode is passed)"},
121-
{RPCResult::Type::STR, "connection_type", "Type of connection: \n" + Join(CONNECTION_TYPE_DOC, ",\n") + "."},
121+
{RPCResult::Type::STR, "connection_type", "Type of connection: \n" + Join(CONNECTION_TYPE_DOC, ",\n") + ".\n"
122+
"Please note this output is unlikely to be stable in upcoming releases as we iterate to\n"
123+
"best capture connection behaviors."},
122124
{RPCResult::Type::NUM, "startingheight", "The starting height (block) of the peer"},
123125
{RPCResult::Type::NUM, "banscore", "The ban score (DEPRECATED, returned only if config option -deprecatedrpc=banscore is passed)"},
124126
{RPCResult::Type::NUM, "synced_headers", "The last header we have in common with this peer"},

0 commit comments

Comments
 (0)