This is an automated email from the ASF dual-hosted git repository.
sbp pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/tooling-trusted-releases.git
The following commit(s) were added to refs/heads/main by this push:
new 6123444 Add more information about type error ignore conventions
6123444 is described below
commit 6123444f9a237aa37fd81efebea1b03f9629ad94
Author: Sean B. Palmer <[email protected]>
AuthorDate: Mon Dec 1 18:32:15 2025 +0000
Add more information about type error ignore conventions
---
atr/docs/code-conventions.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/atr/docs/code-conventions.md b/atr/docs/code-conventions.md
index 7d5fb96..52389f5 100644
--- a/atr/docs/code-conventions.md
+++ b/atr/docs/code-conventions.md
@@ -57,7 +57,7 @@ When you find yourself nesting code more than two or three
levels deep, extract
### Do not use lint or type checker ignore statements
-You must not use `# noqa`, `# type: ignore`, or equivalents such as `cast`,
even to ignore specific errors. The single exception to this is when there is a
bug in the linter or type checker.
+You must not use `# noqa`, `# type: ignore`, or equivalents such as `cast`,
even to ignore specific errors. The single exception to this is when there is a
bug in the linter or type checker. Such ignores should be scoped to the
category of error being raised by the checker. We currently use pyright for
checking, where one additional restriction is that ignores of the style `#
type: ignore` or `# type: ignore[category]` must not be used.
File level lint ignores can be added to the project's `pyproject.toml`, but
they must be used sparingly.
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
