Commit 4f164ee
docs: fix misleading debugger support section in README (#1132)
The README showed a plain py_binary with debugpy in deps and
DEBUGPY_WAIT in env, implying this works out of the box. It doesn't —
py_binary's launcher has no debugpy integration, so the env var is
ignored. Users need the py_debuggable_binary macro from
examples/debugger/ which generates a wrapper entrypoint that actually
starts the debugpy listener.
Update the README to clarify that a wrapper is required and point to the
example for the full working setup.
Close #1054
### Changes are visible to end-users: no
### Test plan
- Covered by existing test cases
Co-authored-by: Joshua Bronson <joshua.bronson@chicagotrading.com>1 parent cb89aa7 commit 4f164ee
1 file changed
Lines changed: 18 additions & 9 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
368 | 368 | | |
369 | 369 | | |
370 | 370 | | |
371 | | - | |
| 371 | + | |
| 372 | + | |
| 373 | + | |
| 374 | + | |
372 | 375 | | |
373 | | - | |
374 | | - | |
375 | | - | |
376 | | - | |
377 | | - | |
378 | | - | |
379 | | - | |
380 | | - | |
| 376 | + | |
| 377 | + | |
| 378 | + | |
| 379 | + | |
| 380 | + | |
| 381 | + | |
| 382 | + | |
| 383 | + | |
| 384 | + | |
| 385 | + | |
| 386 | + | |
| 387 | + | |
| 388 | + | |
| 389 | + | |
381 | 390 | | |
382 | 391 | | |
383 | 392 | | |
| |||
0 commit comments