doc: Remove dev note section on includes

This commit is contained in:
MarcoFalke
2025-05-20 18:27:22 +02:00
parent fa6623d85a
commit fad6cd739b
2 changed files with 4 additions and 8 deletions

View File

@@ -166,6 +166,10 @@ def main():
# Enforce bracket syntax includes
quote_syntax_inclusions = find_quote_syntax_inclusions()
# *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.
if quote_syntax_inclusions:
print("Please use bracket syntax includes (\"#include <foo.h>\") instead of quote syntax includes:")