RPCHelpMan: Support required arguments after optional ones #14875

pull MarcoFalke wants to merge 1 commits into bitcoin:master from MarcoFalke:Mf1812-rpcOptional changing 2 files +8 −10
  1. MarcoFalke commented at 4:22 pm on December 5, 2018: member

    There was a requirement that required arguments could not be positioned after an optional argument, but the deprecation of priority made the second argument to prioritisetransaction optional. So support that in RPCHelpMan.

    Also format all named arguments in the same way (without the wrapping " even for strings), since the extended description already mentions the type and it feels odd to special case strings.

  2. MarcoFalke added the label Docs on Dec 5, 2018
  3. MarcoFalke added the label RPC/REST/ZMQ on Dec 5, 2018
  4. MarcoFalke added this to the milestone 0.18.0 on Dec 5, 2018
  5. MarcoFalke force-pushed on Dec 5, 2018
  6. MarcoFalke force-pushed on Dec 5, 2018
  7. MarcoFalke commented at 7:12 pm on December 5, 2018: member
     0-prioritisetransaction "txid" dummy fee_delta
     1+prioritisetransaction "txid" ( dummy ) fee_delta
     2 Accepts the transaction into mined blocks at a higher (or lower) priority
     3 
     4 Arguments:
     5-1. "txid"       (string, required) The transaction id.
     6-2. dummy        (numeric, required) API-Compatibility for previous API. Must be zero or null.
     7+1. txid         (string, required) The transaction id.
     8+2. dummy        (numeric, optional, default=null) API-Compatibility for previous API. Must be zero or null.
     9                 DEPRECATED. For forward compatibility use named arguments and omit this parameter.
    10 3. fee_delta    (numeric, required) The fee value (in satoshis) to add (or subtract, if negative).
    11                 Note, that this value is not a fee rate. It is a value to modify absolute fee of the TX.
    
  8. DrahtBot commented at 3:58 pm on December 6, 2018: member

    The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.

    Conflicts

    Reviewers, this pull request conflicts with the following ones:

    • #14885 (rpc: Assert named arguments are unique in RPCHelpMan by promag)

    If you consider this pull request important, please also help to review the conflicting pull requests. Ideally, start with the one that should be merged first.

  9. RPCHelpMan: Support required arguments after optional ones fa9a5bc1a0
  10. MarcoFalke force-pushed on Dec 10, 2018
  11. MarcoFalke referenced this in commit f080c65a09 on Dec 18, 2018
  12. MarcoFalke merged this on Dec 18, 2018
  13. MarcoFalke closed this on Dec 18, 2018

  14. MarcoFalke deleted the branch on Dec 18, 2018
  15. DrahtBot locked this on Sep 8, 2021


MarcoFalke DrahtBot

Labels
Docs RPC/REST/ZMQ

Milestone
0.18.0


github-metadata-mirror

This is a metadata mirror of the GitHub repository bitcoin/bitcoin. This site is not affiliated with GitHub. Content is generated from a GitHub metadata backup.
generated: 2024-11-18 12:12 UTC

This site is hosted by @0xB10C
More mirrored repositories can be found on mirror.b10c.me