Document bisect_cmd
Open
Nobody has claimed this yet.
topic-test
type-feature
- Dominant language
- Python
- Stars
- 2.1k
- Forks
- 1k
- Avg merge
- 2d 12h
- Merged PRs (30d)
- 12
Description
In 2017, Victor added a useful tool to find failing tests, bisect_cmd, and blogged about it. I wish I knew about it before!
IMO, the devguide should mention it.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Read Lib/test/bisect_cmd.py and Victor Stinner’s linked blog post to understand the tool and its intended test workflow. Then locate the appropriate testing or debugging section of the devguide and document bisect_cmd there. Done means a newcomer can discover what it does and how to use it to find failing tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100