diff options
| author | Jon Atack <jon@atack.com> | 2019-12-28 21:36:13 +0100 |
|---|---|---|
| committer | Jon Atack <jon@atack.com> | 2019-12-28 21:45:36 +0100 |
| commit | 42ec4994892e67e3430f867af069aafcc2e08593 (patch) | |
| tree | 9412bd5fe62f477a76b8eb9cb78bf3c0e9a8dd6f | |
| parent | b931f61b9ab098ea4ea8fbe4cbf0b03c566c3f63 (diff) | |
doc: developer notes guideline on RPCExamples addresses
to make explicit the use of invalid addresses for user safety and to encourage
the use of bech32 addresses by default.
Fix a typo to appease the linter.
| -rw-r--r-- | doc/developer-notes.md | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/doc/developer-notes.md b/doc/developer-notes.md index b50f552e92..5ed01f2285 100644 --- a/doc/developer-notes.md +++ b/doc/developer-notes.md @@ -919,7 +919,7 @@ introduce accidental changes. Some good examples of scripted-diff: - [scripted-diff: Rename InitInterfaces to NodeContext](https://github.com/bitcoin/bitcoin/commit/301bd41a2e6765b185bd55f4c541f9e27aeea29d) -uses an elegant script to replace occurences of multiple terms in all source files. +uses an elegant script to replace occurrences of multiple terms in all source files. - [scripted-diff: Remove g_connman, g_banman globals](https://github.com/bitcoin/bitcoin/commit/301bd41a2e6765b185bd55f4c541f9e27aeea29d) replaces specific terms in a list of specific source files. @@ -1047,6 +1047,11 @@ A few guidelines for introducing and reviewing new RPC interfaces: new RPC is replacing a deprecated RPC, to avoid both RPCs confusingly showing up in the command list. +- Use *invalid* bech32 addresses for `RPCExamples` help documentation. + + - *Rationale*: Prevent accidental transactions by users and encourage the use + of bech32 addresses by default. + - Use the `UNIX_EPOCH_TIME` constant when describing UNIX epoch time or timestamps in the documentation. |