From 8b3f1e30f0f7bcd1a58efe29f57015ce03f64c50 Mon Sep 17 00:00:00 2001 From: Jon Atack Date: Fri, 8 Apr 2022 15:33:19 +0200 Subject: Update RPC argument and field naming guideline in developer notes Co-authored-by: laanwj <126646+laanwj@users.noreply.github.com> --- doc/developer-notes.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) (limited to 'doc/developer-notes.md') 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. -- cgit v1.2.3