Document debug_just_my_code trait

Open
#910 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
48/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
jupyter, python
Domain
documentation

Research direction

Start by reviewing pull request #863 and the existing ipykernel documentation to find the appropriate configuration section. Document the config needed to enable debugging standard-library and third-party libraries: c.Kernel.debug_just_my_code=False. Done means users can find and understand how to enable this behavior.

Written by the indexing model from the issue text.

Description

https://github.com/ipython/ipykernel/pull/863 implements the ability to debug standard library and 3rd party libraries via a config. This ability is not documented. We should add to the doc the needed config to enable that feature.

c.Kernel.debug_just_my_code=False
Dominant language
Python
Stars
734
Forks
411
Avg merge
1d 2h
Merged PRs (30d)
9

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from ipython/ipykernel

All issues in ipython/ipykernel

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.