diff options
| author | MarcoFalke <falke.marco@gmail.com> | 2022-04-09 15:06:04 +0200 |
|---|---|---|
| committer | MarcoFalke <falke.marco@gmail.com> | 2022-04-09 15:06:08 +0200 |
| commit | 87c7dcc60d62a5bc6b7092b63dba41b55baccf20 (patch) | |
| tree | f2863e1deae83589588de048ed72e23981bffc5b | |
| parent | e0680bbce8b89ad5de9d1b9f818b76df68d72696 (diff) | |
| parent | 8b3f1e30f0f7bcd1a58efe29f57015ce03f64c50 (diff) | |
| download | bitcoin-87c7dcc60d62a5bc6b7092b63dba41b55baccf20.tar.xz | |
Merge bitcoin/bitcoin#24808: doc: update RPC argument and field naming guideline in developer notes
8b3f1e30f0f7bcd1a58efe29f57015ce03f64c50 Update RPC argument and field naming guideline in developer notes (Jon Atack)
Pull request description:
Clarify the doc per the IRC discussion today at https://www.erisian.com.au/bitcoin-core-dev/log-2022-04-08.html#l-229.
ACKs for top commit:
mzumsande:
Code Review ACK 8b3f1e30f0f7bcd1a58efe29f57015ce03f64c50 - I agree with the added guideline.
Tree-SHA512: d0d06bc8d9587c0dc72545843097e48a4e27a9437ceca03c71d0aa4a9b8434971014687d8d2dd012b71e92b26d4ad116697365be3f2a8ed14daecfdb1d0982ef
| -rw-r--r-- | doc/developer-notes.md | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/doc/developer-notes.md b/doc/developer-notes.md index f06902e624..9b1026a375 100644 --- a/doc/developer-notes.md +++ b/doc/developer-notes.md @@ -1220,7 +1220,10 @@ A few guidelines for introducing and reviewing new RPC interfaces: - *Rationale*: Consistency with the existing interface. -- Argument naming: use snake case `fee_delta` (and not, e.g. camel case `feeDelta`) +- Argument and field naming: please consider whether there is already a naming + style or spelling convention in the API for the type of object in question + (`blockhash`, for example), and if so, try to use that. If not, use snake case + `fee_delta` (and not, e.g. `feedelta` or camel case `feeDelta`). - *Rationale*: Consistency with the existing interface. |