Skip to content

docs: fix agent debugging guide typos #76

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ynachiket wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: fix agent debugging guide typos #76

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/agent-resources/debug_instructions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,9 +120,9 @@ Before stopping your debug session, ensure you can answer:
✅ **BEST PRACTICE:** Always set an initial breakpoint before starting debugging
❌ **COMMON MISTAKE:** Set breakpoint in a method signature/definition line like 'def func()'
✅ **BEST PRACTICE:** Set breakpoint in the method body
❌ **COMMON MISTAKE:** Set breakpoint on commented line e.g '//', '#' and ect.
❌ **COMMON MISTAKE:** Set breakpoint on a commented line, e.g. '//', '#', etc.
✅ **BEST PRACTICE:** Set breakpoint only on executable lines.
❌ **COMMON MISTAKE:** Step over the problematic line without fully understanding why the issue occured.
❌ **COMMON MISTAKE:** Step over the problematic line without fully understanding why the issue occurred.
✅ **BEST PRACTICE:** Stop the session, set breakpoint in the problematic line and restart the session.

## 🧹 CLEANUP AFTER ROOT CAUSE VERIFICATION
Expand Down