Skip to content

docs: add a basic debugging page to the programming guide - #2999

Open
FlixalotTheComposer wants to merge 1 commit into
pythonarcade:developmentfrom
FlixalotTheComposer:docs-debugging-guide
Open

FlixalotTheComposer wants to merge 1 commit into
pythonarcade:developmentfrom
FlixalotTheComposer:docs-debugging-guide

Conversation

@FlixalotTheComposer

Copy link
Copy Markdown

Adds a new "Debugging" page to the programming guide, covering the checklist in #1300:

  • A general overview of debugging
  • Print debugging with f-strings (including the {name=} form), and why not to print every frame
  • Mentions that debuggers exist and what they offer, with links to the VS Code and PyCharm docs, plus breakpoint() / pdb for the terminal
  • Arcade-specific tools: drawing hit boxes, and the timing tools (enable_timings, get_fps, print_timings, PerfGraph), linking to the existing performance page and example
  • Checking the environment with python -m arcade info, and a note that Arcade needs a specific pyglet version (this covers the pyglet version issues mentioned in the comments)
  • What to include when asking for help

The page is added to the Manual toctree in doc/index.rst, after the performance page.

I checked every API name and the arcade info command against the code in this repo, and confirmed the external links load. I did not run a full Sphinx build, so please let me know if the docs build or spellcheck complains about anything. I'm happy to change the wording, the order, or cut sections.

Addresses #1300. I left the issue open in case you want more topics added later, such as the -I flag tip from the comments.

Covers print debugging, using a debugger (VS Code, PyCharm, pdb),
drawing hit boxes, the performance timing tools, checking the
environment with 'python -m arcade info', and what to include when
asking for help.

Addresses pythonarcade#1300

This branch has not been deployed

No deployments
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.

1 participant