Skip to content

Commit 32f04e6

Browse files
committed
rpc documentation improvements
1 parent 555eafa commit 32f04e6

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

src/rpc/blockchain.cpp

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1621,9 +1621,9 @@ const std::vector<RPCResult> RPCHelpForDeployment{
16211621
{RPCResult::Type::NUM_TIME, "start_time", "the minimum median time past of a block at which the bit gains its meaning"},
16221622
{RPCResult::Type::NUM_TIME, "timeout", "the median time past of a block at which the deployment is considered failed if not yet locked in"},
16231623
{RPCResult::Type::NUM, "min_activation_height", "minimum height of blocks for which the rules may be enforced"},
1624-
{RPCResult::Type::STR, "status", "bip9 status of specified block (one of \"defined\", \"started\", \"locked_in\", \"active\", \"failed\")"},
1624+
{RPCResult::Type::STR, "status", "status of deployment at specified block (one of \"defined\", \"started\", \"locked_in\", \"active\", \"failed\")"},
16251625
{RPCResult::Type::NUM, "since", "height of the first block to which the status applies"},
1626-
{RPCResult::Type::STR, "status-next", "bip9 status of next block"},
1626+
{RPCResult::Type::STR, "status-next", "status of deployment at the next block"},
16271627
{RPCResult::Type::OBJ, "statistics", /*optional=*/true, "numeric statistics about signalling for a softfork (only for \"started\" and \"locked_in\" status)",
16281628
{
16291629
{RPCResult::Type::NUM, "period", "the length in blocks of the signalling period"},
@@ -1653,9 +1653,9 @@ UniValue DeploymentInfo(const CBlockIndex* tip, const Consensus::Params& consens
16531653
static RPCHelpMan getdeploymentinfo()
16541654
{
16551655
return RPCHelpMan{"getdeploymentinfo",
1656-
"Returns an object containing various state info regarding soft-forks.",
1656+
"Returns an object containing various state info regarding deployments of consensus changes.",
16571657
{
1658-
{"blockhash", RPCArg::Type::STR_HEX, RPCArg::Default{"chain tip"}, "The block hash at which to query fork state"},
1658+
{"blockhash", RPCArg::Type::STR_HEX, RPCArg::Default{"hash of current chain tip"}, "The block hash at which to query deployment state"},
16591659
},
16601660
RPCResult{
16611661
RPCResult::Type::OBJ, "", "", {

0 commit comments

Comments
 (0)