rpc: fix waitfornewblock description

Sjors · Sjors · commit 77ec072925a6 · 2024-09-17T09:27:44.000+02:00
The waitforblock RPC method takes a hash argument and waits for that specific block.  The waitfornewblock waits for any new block. This commit fixes the documentation.
diff --git a/src/rpc/blockchain.cpp b/src/rpc/blockchain.cpp
@@ -275,7 +275,7 @@ void RPCNotifyBlockChange(const CBlockIndex* pindex)
 static RPCHelpMan waitfornewblock()
 {
     return RPCHelpMan{"waitfornewblock",
-                "\nWaits for a specific new block and returns useful info about it.\n"
+                "\nWaits for any new block and returns useful info about it.\n"
                 "\nReturns the current block on timeout or exit.\n",
                 {
                     {"timeout", RPCArg::Type::NUM, RPCArg::Default{0}, "Time in milliseconds to wait for a response. 0 indicates no timeout."},

Original file line number	Diff line number	Diff line change
`@@ -275,7 +275,7 @@ void RPCNotifyBlockChange(const CBlockIndex* pindex)`
`275`	`275`	`static RPCHelpMan waitfornewblock()`
`276`	`276`	`{`
`277`	`277`	`return RPCHelpMan{"waitfornewblock",`
`278`		`- "\nWaits for a specific new block and returns useful info about it.\n"`
	`278`	`+ "\nWaits for any new block and returns useful info about it.\n"`
`279`	`279`	`"\nReturns the current block on timeout or exit.\n",`
`280`	`280`	`{`
`281`	`281`	`{"timeout", RPCArg::Type::NUM, RPCArg::Default{0}, "Time in milliseconds to wait for a response. 0 indicates no timeout."},`