doc: improve listbanned help

jarolrod · jarolrod · commit c95c61657afd · 2021-04-06T18:22:20.000-04:00
Add descriptions for the address, ban_created, and banned_until fields.
diff --git a/src/rpc/net.cpp b/src/rpc/net.cpp
@@ -749,9 +749,9 @@ static RPCHelpMan listbanned()
             {
                 {RPCResult::Type::OBJ, "", "",
                     {
-                        {RPCResult::Type::STR, "address", ""},
-                        {RPCResult::Type::NUM_TIME, "ban_created", ""},
-                        {RPCResult::Type::NUM_TIME, "banned_until", ""},
+                        {RPCResult::Type::STR, "address", "The IP/Subnet of the banned node"},
+                        {RPCResult::Type::NUM_TIME, "ban_created", "The " + UNIX_EPOCH_TIME + " the ban was created"},
+                        {RPCResult::Type::NUM_TIME, "banned_until", "The " + UNIX_EPOCH_TIME + " the ban expires"},
                     }},
             }},
                 RPCExamples{

Original file line number	Diff line number	Diff line change
`@@ -749,9 +749,9 @@ static RPCHelpMan listbanned()`
`749`	`749`	`{`
`750`	`750`	`{RPCResult::Type::OBJ, "", "",`
`751`	`751`	`{`
`752`		`- {RPCResult::Type::STR, "address", ""},`
`753`		`- {RPCResult::Type::NUM_TIME, "ban_created", ""},`
`754`		`- {RPCResult::Type::NUM_TIME, "banned_until", ""},`
	`752`	`+ {RPCResult::Type::STR, "address", "The IP/Subnet of the banned node"},`
	`753`	`+ {RPCResult::Type::NUM_TIME, "ban_created", "The " + UNIX_EPOCH_TIME + " the ban was created"},`
	`754`	`+ {RPCResult::Type::NUM_TIME, "banned_until", "The " + UNIX_EPOCH_TIME + " the ban expires"},`
`755`	`755`	`}},`
`756`	`756`	`}},`
`757`	`757`	`RPCExamples{`