diff options
| author | James Laird-Wah <james@laird-wah.net> | 2018-09-15 11:50:12 +1000 |
|---|---|---|
| committer | Drashna Jaelre <drashna@live.com> | 2018-09-15 09:37:06 -0700 |
| commit | b1f11636c63694f0e94504e5752e963c73f86c3b (patch) | |
| tree | d90ce9576adc95b57f9a6ed28fa090aef2eec8e7 /docs | |
| parent | 48a992f1c037658bbacccefd2709ffdcda8bb345 (diff) | |
| download | firmware-b1f11636c63694f0e94504e5752e963c73f86c3b.tar.gz firmware-b1f11636c63694f0e94504e5752e963c73f86c3b.tar.bz2 firmware-b1f11636c63694f0e94504e5752e963c73f86c3b.zip | |
docs/contributing: add `#pragma once` to Coding Conventions
This supersedes the older include guard mechanism since all the
compilers now support it. It's easier for new users and less prone
to error.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/contributing.md | 1 |
1 files changed, 1 insertions, 0 deletions
diff --git a/docs/contributing.md b/docs/contributing.md index 8242cc1ad..7ed7cd06a 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -70,6 +70,7 @@ Most of our style is pretty easy to pick up on, but right now it's not entirely * Do not write obvious comments * If you not sure if a comment is obvious, go ahead and include it. * In general we don't wrap lines, they can be as long as needed. If you do choose to wrap lines please do not wrap any wider than 76 columns. +* We use `#pragma once` at the start of header files rather than old-style include guards (`#ifndef THIS_FILE_H`, `#define THIS_FILE_H`, ..., `#endif`) # General Guidelines |