Repository navigation
AGENTS.md: static analysis may need explicit type annotations - #75
Conversation
There was a problem hiding this comment.
🟢 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.mdfrom "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
AGENTS.mdsaid 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, soAGENTS.mdnow says annotations may be needed, in line with the guide.