From 8c14607dbd48af1beaed057c165a2c21230d923e Mon Sep 17 00:00:00 2001
From: jgart
Date: Tue, 21 Dec 2021 03:22:21 -0500
Subject: add topic on using pudb

---
 topics/pudb/using-pudb.gmi | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)
 create mode 100644 topics/pudb/using-pudb.gmi

(limited to 'topics')

diff --git a/topics/pudb/using-pudb.gmi b/topics/pudb/using-pudb.gmi
new file mode 100644
index 0000000..877a700
--- /dev/null
+++ b/topics/pudb/using-pudb.gmi
@@ -0,0 +1,21 @@
+# Using pudb
+
+## Setting Breakpoints
+
+You can add the following line anywhere in your code to start a pudb breakpoint:
+
+```
+import pudb; pudb.set_trace()
+```
+
+You can also press `b` in pudb to add a breakpoint with a keyboard shortcut.
+
+## pdb and pudb API similarity
+
+The standard pdb docs should work for pudb with one small exception.
+
+> At the programming language level, PuDB displays the same interface
+> as Python’s built-in pdb module. Just replace pdb with pudb. (One
+> exception: run is called runstatement.)
+
+=> https://docs.python.org/3/library/pdb.html?highlight=pdb#module-pdb
-- 
cgit v1.2.3