Skip to content

Document that -r is required when building in debug mode - #3100

Merged
freakboy3742 merged 3 commits into
beeware:mainfrom
garvitshrma:debug-docs-2621
Oct 27, 2026
Merged

freakboy3742 merged 3 commits into
beeware:mainfrom
garvitshrma:debug-docs-2621

Conversation

@garvitshrma

@garvitshrma garvitshrma commented Oct 23, 2026 •

Copy link
Copy Markdown
Contributor

The documented debug flow doesn't work if the app has already been built; briefcase build --debug pdb and briefcase build --debug debugpy only reinstall requirements when -r is passed. The part that it only reinstalls if -r is used wasn't documented.

Changes:

  1. Added -r to briefcase build examples on the PDB and VS Code how-to pages with a short explanation on why an -r is needed.
  2. Added the equivalent -r note to the --debug section of run.md.
  3. Minor fix not included in the issue: Changed the wording from VS Code debugger to PDB Debugger on the PDB page which might have been mistakenly copied from vscode.md.

Fixes #2621

PR Checklist:

  • I will abide by the BeeWare Code of Conduct
  • I have read and have followed the CONTRIBUTING.md file
  • This PR was generated or assisted using an AI tool

Assisted-by: Claude Opus 5

@freakboy3742 freakboy3742 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've downgraded the release note to a misc - this is an important correction in the docs, but not something that needs to be called out in the next release notes. Otherwise, this is great - thanks for the PR!

@freakboy3742
freakboy3742 merged commit 076ddf8 into beeware:main Oct 27, 2026
57 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Debug documentation issues

2 participants