From ede73705e7970f3ad3e2a0cce29d7a44663eecef Mon Sep 17 00:00:00 2001 From: alexandrebarbaruiva Date: Tue, 16 Jun 2020 09:42:27 -0300 Subject: [PATCH] Add documentation to set_trace's arguments --- README.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.rst b/README.rst index 22f7161..ff893fe 100644 --- a/README.rst +++ b/README.rst @@ -28,6 +28,13 @@ Example usage: result = ipdb.runcall(function, arg0, arg1, kwarg='foo') result = ipdb.runeval('f(1,2) - 3') +Arguments for `set_trace` ++++++++++++++++++++++++++ + +The `set_trace` function accepts `context` which will show as many lines of code as defined, +and `cond`, which accepts boolean values (such as `abc == 17`) and will start ipdb's +interface whenever `cond` equals to `True`. + Using configuration file ++++++++++++++++++++++++