Skip to content

Commit 434f5a2

Browse files
ryanofskymeshcollider
authored andcommitted
Recommend #include<> syntax in developer notes
1 parent 96b9281 commit 434f5a2

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

doc/developer-notes.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -492,6 +492,14 @@ namespace {
492492

493493
- *Rationale*: Avoids confusion about the namespace context
494494

495+
- Prefer `#include <primitives/transaction.h>` bracket syntax instead of
496+
`#include "primitives/transactions.h"`` quote syntax when possible.
497+
498+
- *Rationale*: Bracket syntax is less ambiguous because the preprocessor
499+
searches a fixed list of include directories without taking location of the
500+
source file into account. This allows quoted includes to stand out more when
501+
the location of the source file actually is relevant.
502+
495503
GUI
496504
-----
497505

0 commit comments

Comments
 (0)