mirrors/bitcoin
1
0
Fork 0
mirror of https://github.com/bitcoin/bitcoin.git synced 2025-02-22 15:04:44 +01:00
Code Issues Projects Releases Wiki Activity

Restorewallet/createwallet help documentation fixups/improvements

Browse source
This commit is contained in:
Jon Atack 2023-05-13 07:50:16 +02:00 • committed by Sebastian Falbesoner
parent a00ae31fcc
commit 5c77db7354
2 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
src/wallet/rpc/backup.cpp
View file

@ -1862,7 +1862,7 @@ RPCHelpMan listdescriptors()
RPCHelpMan backupwallet() RPCHelpMan backupwallet()
{ {
return RPCHelpMan{"backupwallet", return RPCHelpMan{"backupwallet",
"\nSafely copies current wallet file to destination, which can be a directory or a path with filename.\n", "\nSafely copies the current wallet file to the specified destination, which can either be a directory or a path with a filename.\n",
{ {
{"destination", RPCArg::Type::STR, RPCArg::Optional::NO, "The destination directory or file"}, {"destination", RPCArg::Type::STR, RPCArg::Optional::NO, "The destination directory or file"},
}, },
@ -1897,7 +1897,7 @@ RPCHelpMan restorewallet()
{ {
return RPCHelpMan{ return RPCHelpMan{
"restorewallet", "restorewallet",
"\nRestore and loads a wallet from backup.\n" "\nRestores and loads a wallet from backup.\n"
"\nThe rescan is significantly faster if a descriptor wallet is restored" "\nThe rescan is significantly faster if a descriptor wallet is restored"
"\nand block filters are available (using startup option \"-blockfilterindex=1\").\n", "\nand block filters are available (using startup option \"-blockfilterindex=1\").\n",
{ {
@ -1909,7 +1909,7 @@ RPCHelpMan restorewallet()
RPCResult::Type::OBJ, "", "", RPCResult::Type::OBJ, "", "",
{ {
{RPCResult::Type::STR, "name", "The wallet name if restored successfully."}, {RPCResult::Type::STR, "name", "The wallet name if restored successfully."},
{RPCResult::Type::ARR, "warnings", /*optional=*/true, "Warning messages, if any, related to restoring the wallet.", {RPCResult::Type::ARR, "warnings", /*optional=*/true, "Warning messages, if any, related to restoring and loading the wallet.",
{ {
{RPCResult::Type::STR, "", ""}, {RPCResult::Type::STR, "", ""},
}}, }},

4
src/wallet/rpc/wallet.cpp
View file

@ -350,7 +350,7 @@ static RPCHelpMan createwallet()
RPCResult::Type::OBJ, "", "", RPCResult::Type::OBJ, "", "",
{ {
{RPCResult::Type::STR, "name", "The wallet name if created successfully. If the wallet was created using a full path, the wallet_name will be the full path."}, {RPCResult::Type::STR, "name", "The wallet name if created successfully. If the wallet was created using a full path, the wallet_name will be the full path."},
{RPCResult::Type::ARR, "warnings", /*optional=*/true, "Warning messages, if any, related to creating the wallet.", {RPCResult::Type::ARR, "warnings", /*optional=*/true, "Warning messages, if any, related to creating and loading the wallet.",
{ {
{RPCResult::Type::STR, "", ""}, {RPCResult::Type::STR, "", ""},
}}, }},
@ -433,7 +433,7 @@ static RPCHelpMan createwallet()
static RPCHelpMan unloadwallet() static RPCHelpMan unloadwallet()
{ {
return RPCHelpMan{"unloadwallet", return RPCHelpMan{"unloadwallet",
"Unloads the wallet referenced by the request endpoint otherwise unloads the wallet specified in the argument.\n" "Unloads the wallet referenced by the request endpoint, otherwise unloads the wallet specified in the argument.\n"
"Specifying the wallet name on a wallet endpoint is invalid.", "Specifying the wallet name on a wallet endpoint is invalid.",
{ {
{"wallet_name", RPCArg::Type::STR, RPCArg::DefaultHint{"the wallet name from the RPC endpoint"}, "The name of the wallet to unload. If provided both here and in the RPC endpoint, the two must be identical."}, {"wallet_name", RPCArg::Type::STR, RPCArg::DefaultHint{"the wallet name from the RPC endpoint"}, "The name of the wallet to unload. If provided both here and in the RPC endpoint, the two must be identical."},