Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make devs aware of debugging and ipdb in docs #2220

Merged
merged 1 commit into from
Feb 22, 2023
Merged

Make devs aware of debugging and ipdb in docs #2220

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions docs/getting_started/index.rst
View file
Open in desktop
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