doc: Mark proprietary array optional

MarcoFalke · MarcoFalke · commit faa51a6aa929 · 2022-01-04T17:57:50.000+01:00
Also, remove not needed '\n's.
Can be reviewed with --word-diff-regex=.
diff --git a/src/rpc/rawtransaction.cpp b/src/rpc/rawtransaction.cpp
@@ -1066,8 +1066,9 @@ static RPCHelpMan testmempoolaccept()
 
 static RPCHelpMan decodepsbt()
 {
-    return RPCHelpMan{"decodepsbt",
-                "\nReturn a JSON object representing the serialized, base64-encoded partially signed Bitcoin transaction.\n",
+    return RPCHelpMan{
+        "decodepsbt",
+        "Return a JSON object representing the serialized, base64-encoded partially signed Bitcoin transaction.",
                 {
                     {"psbt", RPCArg::Type::STR, RPCArg::Optional::NO, "The PSBT base64 string"},
                 },
@@ -1176,7 +1177,7 @@ static RPCHelpMan decodepsbt()
                                 {
                                     {RPCResult::Type::STR_HEX, "key", "(key-value pair) An unknown key-value pair"},
                                 }},
-                                {RPCResult::Type::ARR, "proprietary", "The input proprietary map",
+                                {RPCResult::Type::ARR, "proprietary", /*optional=*/true, "The input proprietary map",
                                 {
                                     {RPCResult::Type::OBJ, "", "",
                                     {
@@ -1217,7 +1218,7 @@ static RPCHelpMan decodepsbt()
                                 {
                                     {RPCResult::Type::STR_HEX, "key", "(key-value pair) An unknown key-value pair"},
                                 }},
-                                {RPCResult::Type::ARR, "proprietary", "The output proprietary map",
+                                {RPCResult::Type::ARR, "proprietary", /*optional=*/true, "The output proprietary map",
                                 {
                                     {RPCResult::Type::OBJ, "", "",
                                     {

Original file line number	Diff line number	Diff line change
`@@ -1066,8 +1066,9 @@ static RPCHelpMan testmempoolaccept()`
`1066`	`1066`
`1067`	`1067`	`static RPCHelpMan decodepsbt()`
`1068`	`1068`	`{`
`1069`		`- return RPCHelpMan{"decodepsbt",`
`1070`		`- "\nReturn a JSON object representing the serialized, base64-encoded partially signed Bitcoin transaction.\n",`
	`1069`	`+ return RPCHelpMan{`
	`1070`	`+ "decodepsbt",`
	`1071`	`+ "Return a JSON object representing the serialized, base64-encoded partially signed Bitcoin transaction.",`
`1071`	`1072`	`{`
`1072`	`1073`	`{"psbt", RPCArg::Type::STR, RPCArg::Optional::NO, "The PSBT base64 string"},`
`1073`	`1074`	`},`
`@@ -1176,7 +1177,7 @@ static RPCHelpMan decodepsbt()`
`1176`	`1177`	`{`
`1177`	`1178`	`{RPCResult::Type::STR_HEX, "key", "(key-value pair) An unknown key-value pair"},`
`1178`	`1179`	`}},`
`1179`		`- {RPCResult::Type::ARR, "proprietary", "The input proprietary map",`
	`1180`	`+ {RPCResult::Type::ARR, "proprietary", /optional=/true, "The input proprietary map",`
`1180`	`1181`	`{`
`1181`	`1182`	`{RPCResult::Type::OBJ, "", "",`
`1182`	`1183`	`{`
`@@ -1217,7 +1218,7 @@ static RPCHelpMan decodepsbt()`
`1217`	`1218`	`{`
`1218`	`1219`	`{RPCResult::Type::STR_HEX, "key", "(key-value pair) An unknown key-value pair"},`
`1219`	`1220`	`}},`
`1220`		`- {RPCResult::Type::ARR, "proprietary", "The output proprietary map",`
	`1221`	`+ {RPCResult::Type::ARR, "proprietary", /optional=/true, "The output proprietary map",`
`1221`	`1222`	`{`
`1222`	`1223`	`{RPCResult::Type::OBJ, "", "",`
`1223`	`1224`	`{`