aboutsummaryrefslogtreecommitdiffstats
path: root/README-maintainer
diff options
context:
space:
mode:
authorJay Berkenbilt <ejb@ql.org>2022-05-03 13:41:07 +0200
committerJay Berkenbilt <ejb@ql.org>2022-05-04 00:31:22 +0200
commit92b692466f7a4dbf4e51e6a77713c029a3e18ab1 (patch)
treeba139d7b9c290bfc2a83c2719cf0ce86cf27ad36 /README-maintainer
parentb20f0519224b0c089f78730fb20291cc2d539979 (diff)
downloadqpdf-92b692466f7a4dbf4e51e6a77713c029a3e18ab1.tar.zst
Remove remaining incorrect assert calls from implementation
Diffstat (limited to 'README-maintainer')
-rw-r--r--README-maintainer6
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