Enable --pretty by default
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 20.6k
- Forks
- 3.3k
- PR merge metrics
- PR metrics pending
Description
Feature
Enable --pretty by default. --no-pretty can still be used to get more concise error messages (it already works, so no need to implement it).
--pretty causes mypy to show the line with the error, and mypy will highlight the location on the line where the error was reported:
foo.py:13: error: List item 0 has incompatible type "str"; expected "int" [list-item]
aa = ["x"]
^~~
Also update documentation, including relevant command-line examples which show the error output from mypy.
Pitch
The additional context makes it easier to see what is wrong. For example, there may be multiple possible expressions which can generate the error, and the highlighting makes this obvious.
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
Start by locating the command-line handling for the existing --pretty option and the documentation examples that show mypy error output. Make --pretty the default while preserving the existing --no-pretty behavior, then update affected examples and verify that their output matches the new default.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- cli, documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100