Skip to content

Commit 87c7dcc

Browse files
author
MarcoFalke
committed
Merge bitcoin/bitcoin#24808: doc: update RPC argument and field naming guideline in developer notes
8b3f1e3 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 8b3f1e3 - I agree with the added guideline. Tree-SHA512: d0d06bc8d9587c0dc72545843097e48a4e27a9437ceca03c71d0aa4a9b8434971014687d8d2dd012b71e92b26d4ad116697365be3f2a8ed14daecfdb1d0982ef
2 parents e0680bb + 8b3f1e3 commit 87c7dcc

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

doc/developer-notes.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1220,7 +1220,10 @@ A few guidelines for introducing and reviewing new RPC interfaces:
12201220

12211221
- *Rationale*: Consistency with the existing interface.
12221222

1223-
- Argument naming: use snake case `fee_delta` (and not, e.g. camel case `feeDelta`)
1223+
- Argument and field naming: please consider whether there is already a naming
1224+
style or spelling convention in the API for the type of object in question
1225+
(`blockhash`, for example), and if so, try to use that. If not, use snake case
1226+
`fee_delta` (and not, e.g. `feedelta` or camel case `feeDelta`).
12241227

12251228
- *Rationale*: Consistency with the existing interface.
12261229

0 commit comments

Comments
 (0)