show_error_codes and show_error_code_links missing in documentation
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 20.6k
- Forks
- 3.3k
- PR merge metrics
- PR metrics pending
Description
Documentation
I was going through the documentation to set up a mypy.ini for a new project and noticed that show_error_codes and show_error_code_links are missing here: https://mypy.readthedocs.io/en/stable/config_file.html#configuring-error-messages
The fact that error codes are shown by default is mentioned in the command line documentation (https://mypy.readthedocs.io/en/stable/command_line.html#configuring-error-messages) though --show-error-code-links is missing.
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 config_file.html and command_line.html documentation at the linked configuring-error-messages sections. Check the existing option descriptions and defaults, then document show_error_codes and show_error_code_links consistently in both relevant sections, including the missing command-line link option.
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
- Clearly specified
- Newbie friendliness
- 48/100