From 66df525350435714d716a468ab399f8ad5f05794 Mon Sep 17 00:00:00 2001 From: Federico Claudi Date: Sun, 4 Oct 2020 15:59:38 +0100 Subject: [PATCH 1/3] Update README.md --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index b5c9383..9cde100 100644 --- a/README.md +++ b/README.md @@ -22,10 +22,10 @@ You can also use `pyinspect` to print a function's code directly in your termina # Table of Contents -1. [Installing pyinspect](##Installing pyinspect) -2. [ExamplFinding functionse2](#Findingfunctions) -3. [Third Example](#third-example) -4. [Fourth Example](#fourth-examplehttpwwwfourthexamplecom) +1. [Installing pyinspect](https://github.com/FedeClaudi/pyinspect#installing-pyinspect) +2. [Finding functions](https://github.com/FedeClaudi/pyinspect#finding-functions) +3. [Inspecting functions](https://github.com/FedeClaudi/pyinspect#inspecting-functions) +4. [Tracebacks](https://github.com/FedeClaudi/pyinspect#tracebacks) ## Installing pyinspect From d6b6acc306182da4f42138619348205f6bc04b9b Mon Sep 17 00:00:00 2001 From: Federico Claudi Date: Sun, 4 Oct 2020 16:00:53 +0100 Subject: [PATCH 2/3] Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 9cde100..20c9ea4 100644 --- a/README.md +++ b/README.md @@ -75,6 +75,7 @@ methods = pyinspect.search(Console, 'export') ``` Which gives: + @@ -102,6 +103,7 @@ pi.showme(pi.search) ``` which yields: + From 2ad00e6636c6b9607aad071fa5d888b343d1fe80 Mon Sep 17 00:00:00 2001 From: Federico Claudi Date: Sun, 4 Oct 2020 16:01:12 +0100 Subject: [PATCH 3/3] Update README.md --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 20c9ea4..f213fb3 100644 --- a/README.md +++ b/README.md @@ -129,6 +129,7 @@ a + c # this will give an error ``` and this is the traceback: + > **note**: although we defined three variables (`a`, `b`, `c`) only two where in the line causing the error (`a + c`). `pyinspect` then highlights `a` and `c` in the traceback as this is what you need to know to fix your bug. If you want `pyinspect` to **only** show the variables in the error line pass `relevant_only=True` to `pi.install_traceback()`