diff options
| author | Russell Yanofsky <[email protected]> | 2017-08-15 13:45:16 -0400 |
|---|---|---|
| committer | MeshCollider <[email protected]> | 2017-11-16 08:23:03 +1300 |
| commit | 434f5a2506e982210226cfd24421f381e20173f3 (patch) | |
| tree | e0c40e9b75206e3c58700dfb1c1f2376e36c05a7 /doc | |
| parent | refactor: Include obj/build.h instead of build.h (diff) | |
| download | discoin-434f5a2506e982210226cfd24421f381e20173f3.tar.xz discoin-434f5a2506e982210226cfd24421f381e20173f3.zip | |
Recommend #include<> syntax in developer notes
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/developer-notes.md | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/developer-notes.md b/doc/developer-notes.md index 35797da7a..7f34b07d1 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 ----- |