diff options
| author | fanquake <fanquake@gmail.com> | 2022-03-28 11:50:36 +0100 |
|---|---|---|
| committer | fanquake <fanquake@gmail.com> | 2022-03-28 11:51:03 +0100 |
| commit | 56c4ac55f606cc37b30d5b68e155d4cc2b7c0c2c (patch) | |
| tree | 2f9c2e64e0758e63ece393c27b20e788bdb02bfc | |
| parent | 3297f5c11c72dd83479ff8335e047555e3f8cb3b (diff) | |
| parent | faac877ffd38c3d8515c9e7b585546434f91b741 (diff) | |
Merge bitcoin/bitcoin#24691: Fix getpeerinfo doc
faac877ffd38c3d8515c9e7b585546434f91b741 doc: Fix getpeerinfo doc (MarcoFalke)
Pull request description:
* Replace `node` with `peer`
* Remove unused `\n`
* Mark optional fields optional. See commit 9344697e57bd23d955df493d0581193ca1dc7cca, found by #23083
ACKs for top commit:
fanquake:
ACK faac877ffd38c3d8515c9e7b585546434f91b741
Tree-SHA512: ae4d52a0dcf8e132d9084e632d65fa835b1e7d0ed5c3d45a360570414d1e20bc7fb6500ff9be94b784af1dec5badcd1304153b1a4a59a6c484a87d8afd88b8bd
| -rw-r--r-- | src/rpc/net.cpp | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/src/rpc/net.cpp b/src/rpc/net.cpp index 9eeced27ae..305005077d 100644 --- a/src/rpc/net.cpp +++ b/src/rpc/net.cpp @@ -93,7 +93,7 @@ static RPCHelpMan getpeerinfo() { return RPCHelpMan{ "getpeerinfo", - "\nReturns data about each connected network node as a json array of objects.\n", + "Returns data about each connected network peer as a json array of objects.", {}, RPCResult{ RPCResult::Type::ARR, "", "", @@ -113,7 +113,7 @@ static RPCHelpMan getpeerinfo() { {RPCResult::Type::STR, "SERVICE_NAME", "the service name if it is recognised"} }}, - {RPCResult::Type::BOOL, "relaytxes", "Whether peer has asked us to relay transactions to it"}, + {RPCResult::Type::BOOL, "relaytxes", /*optional=*/true, "Whether peer has asked us to relay transactions to it"}, {RPCResult::Type::NUM_TIME, "lastsend", "The " + UNIX_EPOCH_TIME + " of the last send"}, {RPCResult::Type::NUM_TIME, "lastrecv", "The " + UNIX_EPOCH_TIME + " of the last receive"}, {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() { {RPCResult::Type::STR, "permission_type", Join(NET_PERMISSIONS_DOC, ",\n") + ".\n"}, }}, - {RPCResult::Type::NUM, "minfeefilter", "The minimum fee rate for transactions this peer accepts"}, + {RPCResult::Type::NUM, "minfeefilter", /*optional=*/true, "The minimum fee rate for transactions this peer accepts"}, {RPCResult::Type::OBJ_DYN, "bytessent_per_msg", "", { {RPCResult::Type::NUM, "msg", "The total bytes sent aggregated by message type\n" |