diff options
| author | fanquake <fanquake@gmail.com> | 2021-12-09 15:47:52 +0800 |
|---|---|---|
| committer | fanquake <fanquake@gmail.com> | 2021-12-09 15:55:46 +0800 |
| commit | c4ae714f55ed8c5b2c111975f0e992c932f8df94 (patch) | |
| tree | 666e22abd9c9881bf214b0059a9c79dc580595eb | |
| parent | f727d814bd8df5a5346c128dd4573e457c1970e1 (diff) | |
| parent | faa0833c43b089d502e625ea6189d56ff7a419ae (diff) | |
Merge bitcoin/bitcoin#23714: doc: Normalize RPC description whitespace
faa0833c43b089d502e625ea6189d56ff7a419ae doc: Normalize RPC description whitespace (MarcoFalke)
Pull request description:
It is tedious to manually add trailing newlines after the description so that there is an empty new line before the `Arguments` section.
Fix that by adding it with C++ code.
ACKs for top commit:
fanquake:
ACK faa0833c43b089d502e625ea6189d56ff7a419ae
Tree-SHA512: 061786c7f19d767f2b7a0362b948e34d181f4cc740a60211756da29ece7554e95be39a9beec3e201eddc8da3ea7e22ac917479eae04b230bb7b0db7a9647af8c
| -rw-r--r-- | src/rpc/misc.cpp | 2 | ||||
| -rw-r--r-- | src/rpc/util.cpp | 3 | ||||
| -rwxr-xr-x | test/functional/rpc_generate.py | 4 |
3 files changed, 4 insertions, 5 deletions
diff --git a/src/rpc/misc.cpp b/src/rpc/misc.cpp index 3716d58d4b..62e7ebec63 100644 --- a/src/rpc/misc.cpp +++ b/src/rpc/misc.cpp @@ -301,7 +301,7 @@ static RPCHelpMan deriveaddresses() static RPCHelpMan verifymessage() { return RPCHelpMan{"verifymessage", - "\nVerify a signed message\n", + "Verify a signed message.", { {"address", RPCArg::Type::STR, RPCArg::Optional::NO, "The bitcoin address to use for the signature."}, {"signature", RPCArg::Type::STR, RPCArg::Optional::NO, "The signature provided by the signer in base 64 encoding (see signmessage)."}, diff --git a/src/rpc/util.cpp b/src/rpc/util.cpp index 683cf88af8..4a5cd0a4be 100644 --- a/src/rpc/util.cpp +++ b/src/rpc/util.cpp @@ -620,10 +620,9 @@ std::string RPCHelpMan::ToString() const ret += arg.ToString(/* oneline */ true); } if (was_optional) ret += " )"; - ret += "\n"; // Description - ret += m_description; + ret += "\n\n" + TrimString(m_description) + "\n"; // Arguments Sections sections; diff --git a/test/functional/rpc_generate.py b/test/functional/rpc_generate.py index e55f2e6d12..ac44f0b7f7 100755 --- a/test/functional/rpc_generate.py +++ b/test/functional/rpc_generate.py @@ -17,9 +17,9 @@ class RPCGenerateTest(BitcoinTestFramework): def run_test(self): message = ( - "generate\n" + "generate\n\n" "has been replaced by the -generate " - "cli option. Refer to -help for more information." + "cli option. Refer to -help for more information.\n" ) self.log.info("Test rpc generate raises with message to use cli option") |