diff options
| author | Jon Atack <jon@atack.com> | 2022-04-08 15:33:19 +0200 |
|---|---|---|
| committer | Jon Atack <jon@atack.com> | 2022-04-08 15:46:05 +0200 |
| commit | 8b3f1e30f0f7bcd1a58efe29f57015ce03f64c50 (patch) | |
| tree | f2863e1deae83589588de048ed72e23981bffc5b /doc/developer-notes.md | |
| parent | e0680bbce8b89ad5de9d1b9f818b76df68d72696 (diff) | |
| download | bitcoin-8b3f1e30f0f7bcd1a58efe29f57015ce03f64c50.tar.xz | |
Update RPC argument and field naming guideline in developer notes
Co-authored-by: laanwj <126646+laanwj@users.noreply.github.com>
Diffstat (limited to 'doc/developer-notes.md')
| -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. |