Skip to content

Commit f73782a

Browse files
committed
doc: fix/improve warning helps in {create,load,unload,restore}wallet
- clarify that there can be multiple warning messages - specify the correct wallet action - describe the use of newlines as delimiters
1 parent 8e7179a commit f73782a

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

src/wallet/rpc/backup.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1903,7 +1903,7 @@ RPCHelpMan restorewallet()
19031903
RPCResult::Type::OBJ, "", "",
19041904
{
19051905
{RPCResult::Type::STR, "name", "The wallet name if restored successfully."},
1906-
{RPCResult::Type::STR, "warning", "Warning message if wallet was not loaded cleanly."},
1906+
{RPCResult::Type::STR, "warning", "Warning messages, if any, related to restoring the wallet. Multiple messages will be delimited by newlines."},
19071907
}
19081908
},
19091909
RPCExamples{

src/wallet/rpc/wallet.cpp

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,7 @@ static RPCHelpMan loadwallet()
207207
RPCResult::Type::OBJ, "", "",
208208
{
209209
{RPCResult::Type::STR, "name", "The wallet name if loaded successfully."},
210-
{RPCResult::Type::STR, "warning", "Warning message if wallet was not loaded cleanly."},
210+
{RPCResult::Type::STR, "warning", "Warning messages, if any, related to loading the wallet. Multiple messages will be delimited by newlines."},
211211
}
212212
},
213213
RPCExamples{
@@ -335,7 +335,7 @@ static RPCHelpMan createwallet()
335335
RPCResult::Type::OBJ, "", "",
336336
{
337337
{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."},
338-
{RPCResult::Type::STR, "warning", "Warning message if wallet was not loaded cleanly."},
338+
{RPCResult::Type::STR, "warning", "Warning messages, if any, related to creating the wallet. Multiple messages will be delimited by newlines."},
339339
}
340340
},
341341
RPCExamples{
@@ -422,7 +422,7 @@ static RPCHelpMan unloadwallet()
422422
{"load_on_startup", RPCArg::Type::BOOL, RPCArg::Optional::OMITTED, "Save wallet name to persistent settings and load on startup. True to add wallet to startup list, false to remove, null to leave unchanged."},
423423
},
424424
RPCResult{RPCResult::Type::OBJ, "", "", {
425-
{RPCResult::Type::STR, "warning", "Warning message if wallet was not unloaded cleanly."},
425+
{RPCResult::Type::STR, "warning", "Warning messages, if any, related to unloading the wallet. Multiple messages will be delimited by newlines."},
426426
}},
427427
RPCExamples{
428428
HelpExampleCli("unloadwallet", "wallet_name")

0 commit comments

Comments
 (0)