From 4a3e9c05817a83da4aa5bb4830f6bb5c1531991b Mon Sep 17 00:00:00 2001 From: Philipp Arras <parras@mpa-garching.mpg.de> Date: Sun, 30 May 2021 16:47:51 +0200 Subject: [PATCH] Add note on asserts --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 52395c22a..dd1933654 100644 --- a/README.md +++ b/README.md @@ -134,6 +134,15 @@ The NIFTy package is licensed under the terms of the *without any warranty*. +Contributing +------------ + +Please note our convention not to use pure python `assert` statements in +production code. They are not guaranteed to by executed by python and can be +turned off by the user (`python -O` in cPython). As an alternative use +`ift.myassert`. + + Contributors ------------ -- GitLab