Conversation
There was a problem hiding this comment.
Pull request overview
This PR relocates and rewrites the Python debugging documentation by removing the old python/README.md and introducing a new top-level README.md intended to guide users through debugging Python scripts with UDB’s python add-on.
Changes:
- Deleted the existing Python add-on README under
python/. - Added a new repository top-level
README.mdwith step-by-step usage instructions and a quick reference.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 6 comments.
| File | Description |
|---|---|
python/README.md |
Removes the previous Python add-on documentation from the python/ subdirectory. |
README.md |
Adds a new top-level guide describing how to install and use the python add-on and common upy commands. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| # **Debugging Python Scripts with UDB** | ||
|
|
||
| This guide explains how to use UDB to debug Python scripts using the `python` addon. | ||
|
|
||
| --- |
There was a problem hiding this comment.
@FinnG I'm not sure if the pyproject.toml file is doing anything useful at this point - should we just get rid?
There was a problem hiding this comment.
I think perhaps we might want to keep it if we support building our own version of the library and passing it into udb via environment variable? I have a patch for this, so can look at the pyproject.toml file as part of that.
No description provided.