From 47cba4ee5db34d230f51e3c6afd56265426d07de Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Stefan=20Fr=C3=B6se?= Date: Mon, 16 Jan 2023 09:55:17 +0100 Subject: [PATCH] debugging for devs --- docs/getting_started/index.rst | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/getting_started/index.rst b/docs/getting_started/index.rst index 0338f75f55c..497847c8796 100644 --- a/docs/getting_started/index.rst +++ b/docs/getting_started/index.rst @@ -298,6 +298,17 @@ remove the branch from the local and remote (github). Note the last step can also be done on the GitHub website. +------------------- +Debugging Your Code +------------------- + +More often than not your tests will fail or your algorithm will +show strange behaviour. **Debugging** is one of the power tools each +developer should know. Since using ``print`` statements is **not** debugging and does +not give you access to runtime variables at the point where your code fails, we recommend +using ``pdb`` or ``ipdb`` for an IPython shell. +A nice introdcution can be found `here `_. + --------------------- More Development help ---------------------