diff options
author | Jon Atack <jon@atack.com> | 2019-12-03 18:35:16 +0100 |
---|---|---|
committer | Jon Atack <jon@atack.com> | 2019-12-13 02:05:05 +0100 |
commit | d94d34f05f4ae3efa07de409489d68bbcc216346 (patch) | |
tree | ca7f60f4c394c0e67af0ca2f863fcde78e44b9dc | |
parent | e2f32cb5c5c7f2b1d1fc7003587b6573fb59526a (diff) |
doc: update developer notes wrt unix epoch time
-rw-r--r-- | doc/developer-notes.md | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/doc/developer-notes.md b/doc/developer-notes.md index 49f60c54ec..31d9f4e6d4 100644 --- a/doc/developer-notes.md +++ b/doc/developer-notes.md @@ -1014,7 +1014,7 @@ A few guidelines for introducing and reviewing new RPC interfaces: - A RPC method must either be a wallet method or a non-wallet method. Do not introduce new methods that differ in behavior based on the presence of a wallet. - - *Rationale*: as well as complicating the implementation and interfering + - *Rationale*: As well as complicating the implementation and interfering with the introduction of multi-wallet, wallet and non-wallet code should be separated to avoid introducing circular dependencies between code units. @@ -1041,8 +1041,13 @@ A few guidelines for introducing and reviewing new RPC interfaces: - *Rationale*: RPC methods registered with the same function pointer will be considered aliases and only the first method name will show up in the - `help` rpc command list. + `help` RPC command list. - *Exception*: Using RPC method aliases may be appropriate in cases where a new RPC is replacing a deprecated RPC, to avoid both RPCs confusingly showing up in the command list. + +- Use the `UNIX_EPOCH_TIME` constant when describing UNIX epoch time or + timestamps in the documentation. + + - *Rationale*: User-facing consistency. |