aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorRussell Yanofsky <russ@yanofsky.org>2017-08-15 13:45:16 -0400
committerMeshCollider <dobsonsa68@gmail.com>2017-11-16 08:23:03 +1300
commit434f5a2506e982210226cfd24421f381e20173f3 (patch)
treee0c40e9b75206e3c58700dfb1c1f2376e36c05a7 /doc
parent96b92810a6a9719e03fe7004d5d5c2d6f7b7a5ff (diff)
Recommend #include<> syntax in developer notes
Diffstat (limited to 'doc')
-rw-r--r--doc/developer-notes.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/developer-notes.md b/doc/developer-notes.md
index 35797da7ae..7f34b07d15 100644
--- a/doc/developer-notes.md
+++ b/doc/developer-notes.md
@@ -492,6 +492,14 @@ namespace {
- *Rationale*: Avoids confusion about the namespace context
+- Prefer `#include <primitives/transaction.h>` bracket syntax instead of
+ `#include "primitives/transactions.h"`` quote syntax when possible.
+
+ - *Rationale*: Bracket syntax is less ambiguous because the preprocessor
+ searches a fixed list of include directories without taking location of the
+ source file into account. This allows quoted includes to stand out more when
+ the location of the source file actually is relevant.
+
GUI
-----