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
This commit is contained in:
1 parent
8e7179aa13
commit
f73782a903
2 files changed
+4
-4
No files matched your search
@@ -1903,7 +1903,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::STR, "warning", "Warning message if wallet was not loaded cleanly."},
|
{RPCResult::Type::STR, "warning", "Warning messages, if any, related to restoring the wallet. Multiple messages will be delimited by newlines."},
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
RPCExamples{
|
RPCExamples{
|
||||||
|
|||||||
@@ -207,7 +207,7 @@ static RPCHelpMan loadwallet()
|
|||||||
RPCResult::Type::OBJ, "", "",
|
RPCResult::Type::OBJ, "", "",
|
||||||
{
|
{
|
||||||
{RPCResult::Type::STR, "name", "The wallet name if loaded successfully."},
|
{RPCResult::Type::STR, "name", "The wallet name if loaded successfully."},
|
||||||
{RPCResult::Type::STR, "warning", "Warning message if wallet was not loaded cleanly."},
|
{RPCResult::Type::STR, "warning", "Warning messages, if any, related to loading the wallet. Multiple messages will be delimited by newlines."},
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
RPCExamples{
|
RPCExamples{
|
||||||
@@ -335,7 +335,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::STR, "warning", "Warning message if wallet was not loaded cleanly."},
|
{RPCResult::Type::STR, "warning", "Warning messages, if any, related to creating the wallet. Multiple messages will be delimited by newlines."},
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
RPCExamples{
|
RPCExamples{
|
||||||
@@ -422,7 +422,7 @@ static RPCHelpMan unloadwallet()
|
|||||||
{"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."},
|
{"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."},
|
||||||
},
|
},
|
||||||
RPCResult{RPCResult::Type::OBJ, "", "", {
|
RPCResult{RPCResult::Type::OBJ, "", "", {
|
||||||
{RPCResult::Type::STR, "warning", "Warning message if wallet was not unloaded cleanly."},
|
{RPCResult::Type::STR, "warning", "Warning messages, if any, related to unloading the wallet. Multiple messages will be delimited by newlines."},
|
||||||
}},
|
}},
|
||||||
RPCExamples{
|
RPCExamples{
|
||||||
HelpExampleCli("unloadwallet", "wallet_name")
|
HelpExampleCli("unloadwallet", "wallet_name")
|
||||||
|
|||||||
Reference in new issue
Block a user