python
python copied to clipboard
exercism
[Improve Concept Docs]: TRACEBACKS - Add PDB section
If you have not yet contributed to concept documents, this issue will require some upfront reading to give you the needed background knowledge. Additionally, we recommend reading the existing about.md docs here, and an example of completed concept docs here.
✅ Getting started
Please please read the docs before starting. Posting PRs without reading these docs will be a lot more frustrating for you during the review cycle, and exhaust Exercism's maintainers' time.
General Contributing Docs:
- Contributing to Exercism | Exercism and GitHub | - Contributor Pull Request Guide
- What are those Weird Task Tags about?
- Exercism Formatting and Style Guide
- Exercism Markdown Specification
- Reputation
Documents on Language Tracks and Concepts:
🙏🏽 Desired Improvements and Changes
Add section on PDB, either to #3059 before it's merged or to the merged doc after the PR is approved and merged.
🌟 Original Specifications
Below are the original specifications from the Concept issue. Please use these as a guide in addition to the change list above.
Learn a little around error tracing tools such as PDB, and similar tools in common IDEs.
🎶 Implementation Notes
- Example code should only use syntax & concepts introduced within these docs or one of the prerequisite concept exercises or documents. Where possible, please use REPL formatting, unless you are demonstrating pseudo code or a long code block. Please do not use syntax not previously covered in prerequisite topics or exercises. Please also follow PEP8 guidelines.
- Our markdown and JSON files are checked against prettier . We recommend setting prettier up locally and running it prior to submitting your PR to avoid any CI errors.
🆘 Next Steps & Getting Help
-
If you'd like to work on this issue, comment saying "I'd like to work on this"(there is no real need to wait for a response, just go ahead, we'll assign you and put a[claimed]label on the issue). - If you have any questions while implementing, please post the questions as comments in here, or contact one of the maintainers on our Slack channel.
@bobahop, please add the appropriate tags, so that this issue gets listed on the website. It might also be helpful to add a getting started section, so that contributors have links to docs. An example of that is here . Thanks!
The goal is to write a section in the tracebacks file about the python debugger?
This is my first "big" pr for Exercism, I would appreciate all the feedback I can get.
@meatball133 -- Thank you for picking up the issue and for filing a PR!
I don't have time to review the PR at the moment, but will get to it by the end of the week. 😄 One thing to note for future: Comment on the issue and give us a little time to assign the issue to you and remove the [help wanted] tag -- that way, the issue won't show on the website, and we won't have any confusion as to who is working on it. Otherwise -- this is great! Many thanks!. 🎉 ⭐