foster/bitcoin-bitcoin-core
0
0
Fork 0
mirror of https://github.com/bitcoin/bitcoin.git synced 2025-02-08 10:31:50 -05:00
Code Issues Activity

doc: improve doc for RPCArg::Optional::OMITTED

Browse source
This commit is contained in:
fanquake 2023-01-22 15:05:14 +00:00
parent ea8c7daf7a
commit 83f70c8e86
No known key found for this signature in database
GPG key ID: 2EEB9F5CC09526C1
1 changed files with 5 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
src/rpc/util.h
View file

@ -154,14 +154,11 @@ struct RPCArg {
/** Required arg */
NO,
/**
* The arg is optional for one of two reasons:
*
* Optional arg that is a named argument and has a default value of
* `null`.
*
* Optional argument with default value omitted because they are
* implicitly clear. That is, elements in an array may not
* exist by default.
* Optional argument for which the default value is omitted from
* help text for one of two reasons:
* - It's a named argument and has a default value of `null`.
* - Its default value is implicitly clear. That is, elements in an
* array may not exist by default.
* When possible, the default value should be specified.
*/
OMITTED,