Skip to content

Commit

Permalink
debugging for devs
Browse files Browse the repository at this point in the history
  • Loading branch information
StFroese authored and maxnoe committed Feb 22, 2023
1 parent 6c4bd9c commit 47cba4e
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions docs/getting_started/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://hasil-sharma.github.io/2017-05-13-python-ipdb/>`_.

---------------------
More Development help
---------------------
Expand Down

0 comments on commit 47cba4e

Please sign in to comment.