Skip to content

Commit 83f70c8

Browse files
committed
doc: improve doc for RPCArg::Optional::OMITTED
1 parent ea8c7da commit 83f70c8

File tree

1 file changed

+5
-8
lines changed

1 file changed

+5
-8
lines changed

src/rpc/util.h

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -154,14 +154,11 @@ struct RPCArg {
154154
/** Required arg */
155155
NO,
156156
/**
157-
* The arg is optional for one of two reasons:
158-
*
159-
* Optional arg that is a named argument and has a default value of
160-
* `null`.
161-
*
162-
* Optional argument with default value omitted because they are
163-
* implicitly clear. That is, elements in an array may not
164-
* exist by default.
157+
* Optional argument for which the default value is omitted from
158+
* help text for one of two reasons:
159+
* - It's a named argument and has a default value of `null`.
160+
* - Its default value is implicitly clear. That is, elements in an
161+
* array may not exist by default.
165162
* When possible, the default value should be specified.
166163
*/
167164
OMITTED,

0 commit comments

Comments
 (0)