Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation: Basic debugging techniques overview for programming guide #1300

Open
4 tasks
pushfoo opened this issue Aug 13, 2022 · 1 comment
Open
4 tasks

Comments

@pushfoo
Copy link
Member

pushfoo commented Aug 13, 2022

Documentation request:

What documentation needs to be added?

  • General overview and guidelines for debugging
  • Crude ways such as f-strings for print statements
  • Mention that there are more powerful ways to debug than print statements called debuggers. going over common features
  • Link documentation for debugging for popular platforms such as VSCode and PyCharm / PyCharm CE

Where should it be located?

The programming guide, with links to it from @DragonMoffon 's proposed tutorial series.

Why would it be helpful

It would complement #1298 by helping users work more effectively on their own code.

@pushfoo
Copy link
Member Author

pushfoo commented Feb 17, 2023

This should also note things like the following:

  • Using the -I flag to clear previously installed packages
  • Pyglet version issues

These have been problems when debugging in the past, especially when upgrading projects between arcade versions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants