Skip to content

[docs] Explain ignoring unused-ignore more explicitly #19901

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

[docs] Explain ignoring unused-ignore more explicitly #19901

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions docs/source/error_code_list2.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -481,9 +481,12 @@ Example:
# Error: unused "type: ignore" comment
return a + b # type: ignore

Note that due to a specific nature of this comment, the only way to selectively
silence it, is to include the error code explicitly. Also note that this error is
not shown if the ``# type: ignore`` is not used due to code being statically
Mypy errors can typically be silenced by putting a ``# type: ignore`` comment after them,
but because this is *already* a ``# type: ignore`` comment, the only way to selectively
silence it is to include the error code explicitly, making the comment
``# type: ignore[unused-ignore]``.

This error is not shown if the ``# type: ignore`` is not used due to code being statically
unreachable (e.g. due to platform or version checks).

Example:
Expand Down