Document exit codes for mypy and dmypy
Open
Nobody has claimed this yet.
documentation
priority-1-normal
topic-usability
- Dominant language
- Python
- Stars
- 20.6k
- Forks
- 3.3k
- PR merge metrics
- PR metrics pending
Description
See https://github.com/python/mypy/pull/5982. The rough idea is to exit with:
- 0, if no type errors
- 1, if there are some type errors
- 2, in case of a crash, bad arguments, and other non-standard conditions
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
Review the referenced pull request 5982 and the mypy and dmypy command-line documentation first. Document exit codes 0 for no type errors, 1 for type errors, and 2 for crashes, bad arguments, or other non-standard conditions; done means both tools' documented behavior is covered.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100