Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: Normalize RPC description whitespace #23714

Merged
merged 1 commit into from
Dec 9, 2021
Merged

doc: Normalize RPC description whitespace #23714

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
doc: Normalize RPC description whitespace
  • Loading branch information
MarcoFalke committed Dec 8, 2021
commit faa0833c43b089d502e625ea6189d56ff7a419ae
2 changes: 1 addition & 1 deletion src/rpc/misc.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)."},
Expand Down
3 changes: 1 addition & 2 deletions src/rpc/util.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
4 changes: 2 additions & 2 deletions test/functional/rpc_generate.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ def set_test_params(self):

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")
Expand Down