diff options
author | fanquake <fanquake@gmail.com> | 2023-01-22 15:05:14 +0000 |
---|---|---|
committer | fanquake <fanquake@gmail.com> | 2023-01-22 15:05:14 +0000 |
commit | 83f70c8e860556426305b1d70fa0a3276784e360 (patch) | |
tree | 58ea2dc584a5b80d4eb5c343094d72bc36b990e5 /src/rpc | |
parent | ea8c7daf7a557853a3e5e615d3aa4a6651cc799d (diff) |
doc: improve doc for RPCArg::Optional::OMITTED
Diffstat (limited to 'src/rpc')
-rw-r--r-- | src/rpc/util.h | 13 |
1 files changed, 5 insertions, 8 deletions
diff --git a/src/rpc/util.h b/src/rpc/util.h index 329291fd93..49d98c8365 100644 --- a/src/rpc/util.h +++ b/src/rpc/util.h @@ -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, |