Repository navigation
docs: add a basic debugging page to the programming guide - #2999
Open
FlixalotTheComposer wants to merge 1 commit into
Open
FlixalotTheComposer wants to merge 1 commit into
FlixalotTheComposer wants to merge 1 commit into
Conversation
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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a new "Debugging" page to the programming guide, covering the checklist in #1300:
{name=}form), and why not to print every framebreakpoint()/ pdb for the terminalenable_timings,get_fps,print_timings,PerfGraph), linking to the existing performance page and examplepython -m arcade info, and a note that Arcade needs a specific pyglet version (this covers the pyglet version issues mentioned in the comments)The page is added to the Manual toctree in
doc/index.rst, after the performance page.I checked every API name and the
arcade infocommand 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
-Iflag tip from the comments.