diff options
Diffstat (limited to 'README-maintainer')
| -rw-r--r-- | README-maintainer | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/README-maintainer b/README-maintainer index f4c54324..2e11a11b 100644 --- a/README-maintainer +++ b/README-maintainer @@ -123,6 +123,12 @@ CODING RULES "Code Formatting" section in manual/contributing.rst for details. See also "CODE FORMATTING" below. +* Do not use assert in non-test code for any purpose other than as a + sanity check during development that would be safe to remove in + production. assert is for strong invariant checking. When developing + and using assert for that purpose, make sure to use the Debug + configuration since assert is disabled in other configurations. + * In a source file, include the header file that declares the source class first followed by a blank line. If a config file is needed first, put a blank line between that and the header followed by |