Skip to content

Commit 56c4ac5

Browse files
committed
Merge bitcoin/bitcoin#24691: Fix getpeerinfo doc
faac877 doc: Fix getpeerinfo doc (MarcoFalke) Pull request description: * Replace `node` with `peer` * Remove unused `\n` * Mark optional fields optional. See commit 9344697, found by #23083 ACKs for top commit: fanquake: ACK faac877 Tree-SHA512: ae4d52a0dcf8e132d9084e632d65fa835b1e7d0ed5c3d45a360570414d1e20bc7fb6500ff9be94b784af1dec5badcd1304153b1a4a59a6c484a87d8afd88b8bd
2 parents 3297f5c + faac877 commit 56c4ac5

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

src/rpc/net.cpp

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ static RPCHelpMan getpeerinfo()
9393
{
9494
return RPCHelpMan{
9595
"getpeerinfo",
96-
"\nReturns data about each connected network node as a json array of objects.\n",
96+
"Returns data about each connected network peer as a json array of objects.",
9797
{},
9898
RPCResult{
9999
RPCResult::Type::ARR, "", "",
@@ -113,7 +113,7 @@ static RPCHelpMan getpeerinfo()
113113
{
114114
{RPCResult::Type::STR, "SERVICE_NAME", "the service name if it is recognised"}
115115
}},
116-
{RPCResult::Type::BOOL, "relaytxes", "Whether peer has asked us to relay transactions to it"},
116+
{RPCResult::Type::BOOL, "relaytxes", /*optional=*/true, "Whether peer has asked us to relay transactions to it"},
117117
{RPCResult::Type::NUM_TIME, "lastsend", "The " + UNIX_EPOCH_TIME + " of the last send"},
118118
{RPCResult::Type::NUM_TIME, "lastrecv", "The " + UNIX_EPOCH_TIME + " of the last receive"},
119119
{RPCResult::Type::NUM_TIME, "last_transaction", "The " + UNIX_EPOCH_TIME + " of the last valid transaction received from this peer"},
@@ -144,7 +144,7 @@ static RPCHelpMan getpeerinfo()
144144
{
145145
{RPCResult::Type::STR, "permission_type", Join(NET_PERMISSIONS_DOC, ",\n") + ".\n"},
146146
}},
147-
{RPCResult::Type::NUM, "minfeefilter", "The minimum fee rate for transactions this peer accepts"},
147+
{RPCResult::Type::NUM, "minfeefilter", /*optional=*/true, "The minimum fee rate for transactions this peer accepts"},
148148
{RPCResult::Type::OBJ_DYN, "bytessent_per_msg", "",
149149
{
150150
{RPCResult::Type::NUM, "msg", "The total bytes sent aggregated by message type\n"

0 commit comments

Comments
 (0)