Skip to content

AGENTS.md: static analysis may need explicit type annotations - #75

Merged
zienag merged 1 commit into
yandex:mainfrom
zienag:agents-type-annotations
Oct 28, 2026
Merged

zienag merged 1 commit into
yandex:mainfrom
zienag:agents-type-annotations

Conversation

@zienag

@zienag zienag commented Oct 27, 2026

Copy link
Copy Markdown
Contributor

AGENTS.md said static analysis requires explicit type annotations, while the usage guide says annotations may be needed for type-based keys and the analyzer infers types when it can. The analyzer does infer them, so AGENTS.md now says annotations may be needed, in line with the guide.

Copilot AI balanced review requested due to automatic review settings October 27, 2026 23:30

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

The documentation reword accurately aligns AGENTS.md with the usage guide and analyzer behavior, leaving no conflicting references or outstanding concerns.

No open issues 🎉

What changed in this PR

This PR corrects a factual inconsistency in the repository's agent documentation. The AGENTS.md "Important Constraints" section previously stated that static analysis requires explicit type annotations, which overstated the constraint: the analyzer performs type inference and only needs explicit annotations when inference fails (e.g., for some type-based keys). The updated wording ("may need") brings AGENTS.md in line with the usage guide (SKILL.md) and the analyzer's real behavior, improving accuracy for both human contributors and agents relying on this guidance.

Changes:

  • Softened the static-analysis constraint wording in AGENTS.md from "requires explicit type annotations" to "may need explicit type annotations," matching the usage guide and the analyzer's inference capability.
File Description
AGENTS.md Reworded the static-analysis constraint so it reflects that explicit type annotations are only sometimes needed, consistent with the usage guide and analyzer behavior.

No issues found; the change is accurate, consistent with skills/implicits-usage-guide/SKILL.md, and leaves no conflicting references elsewhere in the repo.

Review effort: Balanced

@zienag
zienag merged commit 07a6e36 into yandex:main Oct 28, 2026
1 check passed
@zienag
zienag deleted the agents-type-annotations branch October 28, 2026 12:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants