python / python/mypy

Should show_error_code_links be documented?

Open
#16,693 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
Python
Stars
20.6k
Forks
3.3k
PR merge metrics
PR metrics pending

Description

Documentation

show_error_code_links is undocumented. Should it be documented? (show_error_codes is deprecated, but I don't think this is related)

https://github.com/SchemaStore/schemastore/issues/3467

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.

Research direction

Start by locating the documentation or configuration reference for show_error_code_links, then compare its treatment with the deprecated show_error_codes option and review the linked SchemaStore issue. Done means determining whether the setting should be documented and, if so, adding the appropriate documentation.

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
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.