aboutsummaryrefslogtreecommitdiff
path: root/src/rpc/util.h
diff options
context:
space:
mode:
authorMarcoFalke <*~=`'#}+{/-|&$^_@721217.xyz>2023-01-23 10:12:51 +0100
committerMarcoFalke <*~=`'#}+{/-|&$^_@721217.xyz>2023-01-23 10:12:58 +0100
commita8c1ea50c74fc2b9e34e18cac0b15399b89b9662 (patch)
tree11497ddaa3589586f7d70898a0d6133e3cb66978 /src/rpc/util.h
parentf99b85642ff16b6687df10f3f323d111f4f0ee98 (diff)
parent83f70c8e860556426305b1d70fa0a3276784e360 (diff)
Merge bitcoin/bitcoin#26919: scripted-diff: use RPCArg::Optional::OMITTED over OMITTED_NAMED_ARG
83f70c8e860556426305b1d70fa0a3276784e360 doc: improve doc for RPCArg::Optional::OMITTED (fanquake) ea8c7daf7a557853a3e5e615d3aa4a6651cc799d scripted-diff: use RPCArg::Optional::OMITTED over OMITTED_NAMED_ARG (fanquake) Pull request description: Remove deprecated `RPCArg::Optional::OMITTED_NAMED_ARG` in favour of `OMITTED`. ACKs for top commit: kouloumos: re-ACK 83f70c8e860556426305b1d70fa0a3276784e360 aureleoules: ACK 83f70c8e860556426305b1d70fa0a3276784e360 Tree-SHA512: caba82c0f9f7969d7534bdcdcdfd80b94c16750598343ce63af28e0d579bfd49405bf28acd66dbc6c9a720f040b0e146a5efdff79ebc5ac7364dab54ab16c4a6
Diffstat (limited to 'src/rpc/util.h')
-rw-r--r--src/rpc/util.h14
1 files changed, 5 insertions, 9 deletions
diff --git a/src/rpc/util.h b/src/rpc/util.h
index 27363eeb50..49d98c8365 100644
--- a/src/rpc/util.h
+++ b/src/rpc/util.h
@@ -154,18 +154,14 @@ 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,
- OMITTED_NAMED_ARG, // Deprecated alias for OMITTED, can be removed
};
/** Hint for default value */
using DefaultHint = std::string;