From 0ef86fc2a0c8129ddd3695266897c5095c9df3d1 Mon Sep 17 00:00:00 2001 From: Emad Rad Date: Wed, 29 Nov 2023 11:23:29 +0330 Subject: [PATCH] docs: add more clarity to debugging section --- docs/dev.rst | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/dev.rst b/docs/dev.rst index d6d2851..9732df8 100644 --- a/docs/dev.rst +++ b/docs/dev.rst @@ -86,7 +86,10 @@ Finally, the platform can also be started back up with ``launch``. It will take Debugging with breakpoints -------------------------- -To debug a local edx-platform repository, add a `python breakpoint `__ with ``breakpoint()`` anywhere in the code. Then, attach to the applicable service's container by running ``start`` (without ``-d``) followed by the service's name:: +To debug a local edx-platform repository, first, start development in detached mode (with ``-d``), add a `python breakpoint `__ with ``breakpoint()`` anywhere in the code. Then, attach to the applicable service's container by running ``start`` (without ``-d``) followed by the service's name:: + + # Start in detached mode: + tutor dev start -d # Debugging LMS: tutor dev start lms