From the course: Debug Your Code with AI

Unlock this course with a free trial

Join today to access over 25,500 courses taught by industry experts.

Documentation for debugging

Documentation for debugging

- [Instructor] Using documentation to your own benefit for debugging is an excellent strategy when we're trying to actually do something interesting and help the large language model, whatever AI service that we're going to be using, to understand what is going on. So I've created one here called DEBUG.md, I chose Markdown. That's pretty popular markup language for large language models. And let's take a look at what we have here. We're going to use DEBUG.md. And here, we have a couple of details. So I have an issue that when there is a SystemExit exception, the plugin fails to parse. This description is part of the issue that I have on the GitHub project. So I'm going to explain also what we're going to be doing here. And in this case, the test for this VIM plugin require fixture files in fixtures directory and the actual test that runs those fixtures in the functional directory. So I'm giving a little bit of hints on where to look and what to do. So what is it that I want? I want to…

Contents