Merge #17819: doc: developer notes guideline on RPCExamples addresses

42ec4994892e67e3430f867af069aafcc2e08593 doc: developer notes guideline on RPCExamples addresses (Jon Atack)

Pull request description:

  to make explicit the use of invalid addresses for user safety and to encourage
  the use of bech32 addresses by default. See https://github.com/bitcoin/bitcoin/pull/17578#discussion_r361752570 and https://github.com/bitcoin/bitcoin/pull/17578#discussion_r362564492.

  Fix a typo to appease the linter.

ACKs for top commit:
  promag:
    ACK 42ec4994892e67e3430f867af069aafcc2e08593, no strong opinion as whether this belongs to developer notes or not but why not.
  fjahr:
    ACK 42ec499
  michaelfolkson:
    ACK 42ec4994892e67e3430f867af069aafcc2e08593

Tree-SHA512: 64f90e227d256aa194c4fd48435440bdc233a51213dd4a6ac5b05d04263f729c6b4bb5f3afd3b87719b20cb1b159d5a9673d58a11b72823a4a6a16e8a26ae10e
This commit is contained in:
MarcoFalke 2020-01-16 15:23:30 -05:00 committed by PastaPastaPasta
parent b741f3a4b0
commit df51c199b4

View File

@ -1186,6 +1186,10 @@ A few guidelines for introducing and reviewing new RPC interfaces:
new RPC is replacing a deprecated RPC, to avoid both RPCs confusingly new RPC is replacing a deprecated RPC, to avoid both RPCs confusingly
showing up in the command list. showing up in the command list.
- Use *invalid* Dash addresses for `RPCExamples` help documentation.
- *Rationale*: Prevent accidental transactions by users.
- Use the `UNIX_EPOCH_TIME` constant when describing UNIX epoch time or - Use the `UNIX_EPOCH_TIME` constant when describing UNIX epoch time or
timestamps in the documentation. timestamps in the documentation.